通过

<summary>

  • 项目

<summary> 标记应当用于描述类型或类型成员。 使用 <remarks> 可针对某个类型说明添加补充信息。

语法

/// <summary>description</summary>

参数

description
对象的摘要。

备注

<summary> 标记的文本是 IntelliSense 中类型相关信息的唯一源，它也在对象浏览器和代码注释 Web 报表中显示。

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

示例

// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>MyMethod is a method in the MyClass class.
   /// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
   /// <seealso cref="MyClass::MyMethod2"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void MyMethod2() {}
};

另请参阅

XML 文档