共用方式為


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

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

參數

  • term
    將定義於 description 中的詞彙。

  • description
    為項目符號、編號清單中的項目或 term 的定義其中之一。

備註

<listheader> 區塊用於定義表格或定義清單的標題列。 在定義表格時,您只需要提供一個詞彙項目做為標題。

清單中的每個項目都以 <item> 區塊來指定。 當建立定義清單時,您必須指定 term 和 description。 但是對於表格、項目符號清單或編號清單,則只需提供 description 的項目。

在清單或表格中可以有全部需要的 <item> 區塊。

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

範例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    static void Main()
    {
    }
}

請參閱

參考

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

概念

C# 程式設計手冊