<list> (Visual Basic)

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

構文

<list type="type">  
   <listheader>  
      <term>term</term>  
      <description>description</description>  
   </listheader>  
   <item>  
      <term>term</term>  
      <description>description</description>  
   </item>  
</list>  

パラメーター

type
リストの型。 箇条書きの場合は "箇条書き"、番号付きリストの場合は "number"、2 列のテーブルの場合は "table" である必要があります。

term
typeが "table" の場合にのみ使用されます。定義する用語。説明タグで定義されます。

description
typeが "箇条書き" または "数値" の場合、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

こちらも参照ください

• XML コメント タグ