<list> (Visual Basic)

リストまたはテーブルを定義します。

構文

<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 タグで定義されています。

description
type が "bullet" または "number" の場合、description は リストの項目です。type が "table" の場合、description は term の定義です。

Remarks

<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

関連項目

• XML のコメント用タグ