<list>【リスト・表】
<listheader>【表のヘッダ部】
<item>【リスト・表のデータ部】
<term>【リスト・表の定義】
<description>【リスト・表の説明】

メモ

概要

  • リスト (項目番号なしリスト・項目番号ありリスト・定義リスト)・表 (定義表・一般表) を記述
    • <list>【リスト・表】の type属性でタイプ指定
  • 詳細は、下記を指定
    • <listheader>【表のヘッダ部】
    • <item>【リスト・表のデータ部】
    • <term>【リスト・表の定義】
    • <description>【リスト・表の説明】

ECMA-334・Doxygen

<list> 属性 タイプ<listHeader><item>
<term><description><term><description>
type="bullet"項目番号なしリスト説明
type="number"項目番号ありリスト説明
type="table"定義リスト定義見出し説明見出し定義説明
表見出し説明

SHFB

<list> 属性 タイプ<listHeader><item>備考
<term><description><term><description>
type="bullet" 項目番号なしリスト[ 定義 ]説明 出力：【定義 (強調)】 - 【説明】(<term> 指定)
説明のみの場合、<term>は省略可
type="number"
[start="###"] 		項目番号ありリスト[ 定義 ]説明 出力：【定義 (強調)】 - 【説明】(<term> 指定)
start 属性：開始項目番号
説明のみの場合、<term>は省略可
type="definition"定義リスト定義説明
type="table" 表[ 見出し ][ 見出し ][ 説明 ][ 説明 ] １セルにつき <term> と <description> の片方を指定

構文

<list type="bullet" | "number" | "table">
  <listheader>
    <term>定義見出し・見出し</term>
    <description>説明見出し</description>
  </listheader>
  <item>
    <term>定義</term>
    <description>説明</description>
  </item>
  ...
  <item>
    <term>定義</term>
    <description>説明</description>
  </item>
</list>


【項目番号なしリスト】
<list type="bullet">
  <item>
    [<term>定義</term>]
    <description>説明</description>
  </item>
  ...
</list>


【項目番号ありリスト】
<list type="number" [start="###"開始項目番号]>
  <item>
    [<term>定義</term>]
    <description>説明</description>
  </item>
  ...
</list>


【定義リスト】
<list type="definition">
  <item>
    <term>定義</term>
    <description>説明</description>
  </item>
  ...
</list>


【表】
<list type="table">
  <listHeader>
    <term>１列目 見出し (<description>でも可)</term>
    <term>２列目 見出し (<description>でも可)</term>
    ...
  </listHeader>
  <item>
    <description>１行１列目 説明 (<term>でも可)</description>
    <description>１行２列目 説明 (<term>でも可)</description>
    ...
  </item>
  ...
</list>

外部リンク

例

/// <summary>
/// 概要
///   <list type="bullet">
///     <item>項目１</item>
///     <item>項目２</item>
///     <item>項目３</item>
///   </list>
///   <list type="number">
///     <item>項目１</item>
///     <item>項目２</item>
///     <item>項目３</item>
///   </list>
///   <list type="table">
///     <listheader>
///       <term>定義見出し</term>
///       <description>説明見出し</description>
///     </listheader>
///     <item>
///       <term>定義１</term>
///       <description>説明１</description>
///     </item>
///     <item>
///       <term>定義２</term>
///       <description>説明２</description>
///     </item>
///     <item>
///       <term>定義３</term>
///       <description>説明３</description>
///     </item>
///   </list>
/// </summary>
public class ClassList { }