共用方式為


<summary> (C# 程式設計手冊)

更新:2007 年 11 月

<summary>description</summary>

參數

  • description
    為物件的摘要。

備註

<summary> 標記應用於描述型別或型別成員。使用 <remarks> 為型別描述加入補充資訊。

<summary> 標記的內容會是 IntelliSense 中有關型別資訊的唯一來源,也會在物件瀏覽器中顯示。

使用 /doc 進行編譯,將文件註解處理為檔案。

範例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

請參閱

概念

C# 程式設計手冊

參考

建議使用的文件註解標籤 (C# 程式設計手冊)