where:
- name
- The name of the parameter to refer to. Enclose the name in double quotation marks (" ").
Remarks
The <paramref> tag gives you a way to indicate that a word is a parameter. The XML file can be processed to format this parameter in some distinct way.
Compile with /doc to process documentation comments to a file.
Example
// xml_paramref_tag.cs
// compile with: /doc:xml_paramref_tag.xml
/// text for class MyClass
public class MyClass
{
/// <remarks>MyMethod is a method in the MyClass class.
/// The <paramref name="Int1"/> parameter takes a number.
/// </remarks>
public static void MyMethod(int Int1)
{
}
/// text for Main
public static void Main ()
{
}
}
See Also
Recommended Tags for Documentation Comments