| title | description | ms.date | f1_keywords | helpviewer_keywords | ms.assetid | |||
|---|---|---|---|---|---|---|---|---|
<paramref> (C++ documentation comments) |
Learn more about the paramref C++ XML documentation tag. |
12/03/2021 |
|
|
c5730dc2-7159-421f-b2d5-bb971e307122 |
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.
/// <paramref name="ref-name"/>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.
Compile with /doc to process documentation comments to a file.
// 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) {}
};