Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

<param> (Visual C++)

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>

Parameters

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.

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) {
   }
};

Community Additions

ADD
Show:
© 2015 Microsoft