| title |
<param> (Visual C++) | Microsoft Docs |
| ms.custom |
|
| ms.date |
11/04/2016 |
| ms.reviewer |
|
| ms.suite |
|
| ms.technology |
|
| ms.tgt_pltfrm |
|
| ms.topic |
article |
| f1_keywords |
|
| dev_langs |
|
| helpviewer_keywords |
param C++ XML tag |
<param> C++ XML tag |
|
| ms.assetid |
66c1a1c3-4f98-4bcf-8c7d-9a40308982fb |
| caps.latest.revision |
10 |
| author |
mikeblome |
| ms.author |
mblome |
| manager |
ghogen |
| translation.priority.ht |
cs-cz |
de-de |
es-es |
fr-fr |
it-it |
ja-jp |
ko-kr |
pl-pl |
pt-br |
ru-ru |
tr-tr |
zh-cn |
zh-tw |
|
The <param> tag should be used in the comment for a method declaration to describe one of the parameters for the method.
<param name='name'>description</param>
name
The name of a method parameter. Enclose the name in single or double quotation marks. The compiler issues a warning if it does not find name.
description
A description for the parameter.
Remarks
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) {
}
};
XML Documentation