<param> (Visual C++)

<param> 标记应当用于方法声明的注释中,以描述方法的一个参数。

<param name='name'>description</param>

参数

  • name
    方法参数名。名称括在单引号或双引号。如果它没有找到 name,编译器会发出警告。

  • description
    参数说明。

备注

<param> 标记的文本将显示在 IntelliSense,对象浏览器以及代码注释 Web 报告。

使用 /doc 进行编译可以将文档注释处理到文件中。

示例

// 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 文档 (Visual C++)