共用方式為

<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 檔