| description | title | ms.date | f1_keywords | helpviewer_keywords | ms.assetid | |||
|---|---|---|---|---|---|---|---|---|
Learn more about: XML documentation tag <param> |
<param> (C++ documentation comments) |
12/03/2021 |
|
|
66c1a1c3-4f98-4bcf-8c7d-9a40308982fb |
The <param> tag should be used in the comment for a method declaration to describe one of the parameters for the method.
/// <param name='param-name'>description</param>param-name
The name of a method parameter. Enclose the name in single or double quotation marks. The compiler issues a warning if it doesn't find param-name.
description
A description for the parameter.
The text for the <param> tag will be displayed in IntelliSense, the Object Browser, and in the Code Comment Web Report.
Compile with /doc to process documentation comments to a file.
// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <param name="Int1">Used to indicate status.</param>
void MyMethod(int Int1) {
}
};