通过

<paramref> 文档标记

  • 项目

<paramref> 标记提供一种方法来支持某个单词是参数。 可处理 XML 文件，以某种不同的方式设置此参数格式。

语法

/// <paramref name="ref-name"/>

参数

ref-name
要引用的参数的名称。 将名称括在单引号或双引号中。 如果编译器没有找到 ref-name，它会发出警告。

备注

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

示例

// xml_paramref_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_paramref_tag.dll
/// Text for class MyClass.
public ref class MyClass {
   /// <summary>MyMethod is a method in the MyClass class.
   /// The <paramref name="Int1"/> parameter takes a number.
   /// </summary>
   void MyMethod(int Int1) {}
};

另请参阅

XML 文档