<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) {
}
};
另请参阅
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈