<list> および <listheader> ドキュメント タグ
<listheader> ブロックを使用して、テーブルまたは定義リストの見出し行を定義します。 テーブルを定義するときにのみ、見出しの用語のエントリを指定する必要があります。
構文
<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 の定義です。
Remarks
リストの各項目は、<item> ブロックで指定されます。 定義リストを作成する場合は、term と description の両方を指定する必要があります。 ただし、テーブル、箇条書きリスト、または番号付きリストの場合は、description のエントリを指定するだけで済みます。
リストまたはテーブルでは、必要な数の <item> ブロックを使用できます。
コンパイル時に /doc を指定して、ドキュメント コメントをファイルに出力します。
例
// xml_list_tag.cpp
// compile with: /doc /LD
// post-build command: xdcmake xml_list_tag.dll
/// <remarks>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </remarks>
class MyClass {};