The <paramref> tag gives you a way to indicate that a word in the code comments, for example in a <summary> or <remarks> block refers to a parameter. This is usually displayed with italic font.
Syntax
<paramref name="name"/>
The name is the name of the parameter to refer to. Enclose the name in double quotation marks (" ").
Examples
Visual Basic
|
 Copy Code
|
''' <summary>Method which compares the string representation
''' of <paramref name="x"/> parameter with string in <paramref name="y"/>
''' parameter.</summary>
Function method1(ByVal x As Integer, ByVal y As String) As Boolean
|
C#
|
Copy Code
|
/// <summary>Method which compares the string representation
/// of <paramref name="x"/> parameter with string in <paramref name="y"/>
/// parameter.</summary>
public bool method1(int x, string y)
|
|
See Also
