Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Syntax
/// <paramref name="ref-name"/>
Parameters
ref-name
The name of the parameter to refer to. Enclose the name in single or double quotation marks. The compiler issues a warning if it doesn't find ref-name.
Remarks
Compile with /doc to process documentation comments to a file.
Example
// xml_paramref_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_paramref_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <summary>MyMethod is a method in the MyClass class.
/// The <paramref name="Int1"/> parameter takes a number.
/// </summary>
void MyMethod(int Int1) {}
};