Export (0) Print
Expand All
4 out of 18 rated this helpful - Rate this topic

<see> (C# Programming Guide)


<see cref="member"/>

Parameters

cref = " member"

A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and passes member to the element name in the output XML. Place member within double quotation marks (" ").

The <see> tag lets you specify a link from within text. Use <seealso> to indicate that text should be placed in a See Also section.

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

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

The following example shows how to make a cref reference to a generic type.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

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

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.