<paramref> (Visual C++)
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at <paramref> (Visual C++).
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="name"/>
Parameters
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 does not find 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) {}
};