共用方式為


<summary> (Visual C++)

<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 文件 (Visual C++)