Export (0) Print
Expand All

<see> (Visual C++)

Updated: October 2008

The <see> tag lets you specify a link from within text. Use <seealso> to indicate text that you might want to appear in a See Also section.

<see cref="member"/>

member

A reference to a member or field that is available to be called from the current compilation environment. Enclose the name in single or double quotation marks.

The compiler checks that the given code element exists and resolves member to the element name in the output XML. The compiler issues a warning if it does not find member.

Compile with /doc to process documentation comments to a file.

See <summary> for an example of using <see>.

The Visual C++ compiler will attempt to resolve cref references in one pass through the documentation comments. Therefore, if using the C++ lookup rules, a symbol is not found by the compiler the reference will be marked as unresolved. See <seealso> (Visual C++) for more information.

The following sample shows how you can make cref reference to a generic type, such that, the compiler will resolve the reference.

// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
/// <see cref="C &lt; T &gt;"/>

// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};
 
/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};

Date

History

Reason

October 2008

Fixed typing error in code example.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft