<list> (Visual Basic)
更新 : 2007 年 11 月
リストまたは表を定義します。
<list type="type">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
パラメータ
type
リストの型を指定します。箇条書きリストの場合は "bullet"、番号付きリストの場合は "number"、2 列の表の場合は "table" です。term
type が "table" の場合のみ使用されます。説明タグで定義された、定義する用語です。description
type が "bullet" または "number" の場合、description はリスト内の項目です。type が "table" の場合、description は term の定義です。
解説
<listheader> ブロックは、表または定義リストの見出しを定義します。表を定義するとき、見出しで指定する必要があるのは、term のエントリだけです。
リストの各項目は、<item> ブロックで指定します。定義リストを作成するときは、term と description の両方を指定する必要があります。ただし、表、箇条書きリスト、または番号付きリストに指定する必要があるのは、description のエントリだけです。
リストや表には、必要な数だけ <item> ブロックを指定できます。
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
この例では、<list> タグを使って、解説セクションに箇条書きリストを定義します。
''' <remarks>Before calling the <c>Reset</c> method, be sure to:
''' <list type="bullet">
''' <item><description>Close all connections.</description></item>
''' <item><description>Save the object state.</description></item>
''' </list>
''' </remarks>
Public Sub Reset()
' Code goes here.
End Sub