<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# プログラミング ガイド