NDoc User's Guide NDoc 1.3


[This is preliminary documentation and subject to change]

The <see> tag specifies a link to other documentation from within text.

<see cref="member">[label]</see>
<see href="URL">[label]</see>
<see langword="null | sealed 
| static | abstract | virtual | true | false"/>


text to display as the link
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. member must appear within double quotation marks (" ").
href = "URL" [NDoc extension]
A reference to an external resource at the address given by the URL.
langword [NDoc extension]
A common .NET language keyword. These keywords are highlighted, and, in some cases, expanded into descriptive phrases (see remarks for further details). Note that although the syntax above only shows the common keywords, any word specified will be highlighted.

Applies To

Can be used inline within any other markup.


Use <seealso> to indicate text that you might want to appear in a See Also section.

Note: As of release 1.3, the MSDN and VS.NET documenters will only create a link on the first occurrence of each unique cref specified within a documentation section; further <see> tags will just be highlighted.  This improves the readability of the documentation.

langword expansions
keyword expansion
null null reference (Nothing in Visual Basic)
sealed sealed (NotInheritable in Visual Basic)
static static (Shared in Visual Basic)
abstract abstract (MustInherit in Visual Basic)
virtual virtual (CanOverride in Visual Basic)


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

See Also

Tag Usage | NDoc Tags | <seealso> | Microsoft's definition