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. The <see> tag can be also used to include language keyword in the text.
Syntax
<see cref="reference">[label]</see>
or
<see href="reference">[label]</see>
or
<see langword="keyword"/>
The first syntax adds a link, with visible text label, that points to the documentation for the specified reference. Warning appears during compilation if reference points to non-existing target. The second syntax adds a link, with visible text label, that points to an external resource, e.g. local file or internet URL. The label is optional. If omitted, instead of it the reference appears as the visible text. Use the label when you want the visible text to be abbreviated or different from the reference. It can contain whitespaces.
The last syntax allows adding the language keyword. The localized text with keyword is inserted in documentation in the place of this tag. The following table lists allowed values of langword parameter and a corresponding (English) text:
langword |
Text |
null |
null reference (Nothing in Visual Basic) |
true |
true |
false |
false |
static |
static (Shared in Visual Basic) |
abstract |
abstract (MustInherit in Visual Basic) |
sealed |
sealed (NotInheritable in Visual Basic) |
virtual |
virtual (Overridable in Visual Basic) |
Examples
|
||||||||