Share via

<param> 文档标记

  • 项目

在方法声明的注释中，应使用 <param> 标记来描述方法参数之一。

语法

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

参数

param-name
方法参数的名称。 将名称括在单引号或双引号中。 如果编译器没有找到 param-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 文档