2 out of 8 rated this helpful - Rate this topic

<see> (C# Programming Guide)

Visual Studio 2010

Copy

<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 (" ").

Remarks

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. Use the cref Attribute to create internal hyperlinks to documentation pages for code elements.

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

See <summary> for an example of how to use <see>.

Reference

Concepts

C# Programming Guide

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

Re: Where is information on how to cref to a generic type?

Tadeusz: I came to this page from the same place you did. The information indeed seems missing. I found the answer on Stack Overflow (http://stackoverflow.com/questions/532166/c-how-to-reference-generic-classes-and-methods-in-xml-documentation):
/// &<lt see cref="FancyClass{T}.FancyMethod{K}(T)"&> for more information.

Edit by SJ at MSFT: I added this information directly in cref instead of directing you here.

History

4/16/2011
Djahoss

11/9/2011
Thomas Lee

C# ECMA document includes useful String Id examples

Sections E3.1 and E3.2 of http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-334.pdf provides several examples of the String ID format that can be used with the cref attribute.

History

8/2/2011
Rich Collette

More Information

http://msdn.microsoft.com/en-us/library/cc837134.aspx
http://msdn.microsoft.com/en-us/library/fsbx0t7x.aspx

History

5/30/2011
Abu Osama