The <list> tag describes a numbered or bulleted list, a definition list or a table.

Syntax

<list type="bullet" | "number" | "table">

   <listheader>

      <term>term</term>

      <description>description</description>

   </listheader>

   <item>

      <term>term</term>

      <description>description</description>

   </item>

</list>

The <listheader> block is used to define the heading row of a table. When defining a table, you only need to supply an entry for term in the heading.

Each item in the list is specified with an <item> block. When creating a definition list, you will need to specify both term and description. However, for a table, bulleted list, or numbered list, you only need to supply an entry for description.

A list or table can have as many <item> blocks as needed. Normally, the table can have only one column (using <term>) or two columns (using <term> and <description>). But you can extend this syntax and create the table with more columns.

Examples

Visual Basic

''' <summary>Our sample property.</summary>

''' <remarks>This property is really interesting. We can use:

''' <list type="number">

''' <item>

''' <description>font formatting or code</description></item>

''' <item>

''' <description>bulleted or numbered lists</description></item>

''' <item>

''' <description>tables, pictures and links</description></item>

''' </list>

''' </remarks>

Property prop1() As String

C#

/// <summary>Our sample property.</summary>

/// <remarks>This property is really interesting. We can use:

/// <list type="number">

/// <item>

/// <description>font formatting or code</description></item>

/// <item>

/// <description>bulleted or numbered lists</description></item>

/// <item>

/// <description>tables, pictures and links</description></item>

/// </list>

/// </remarks>

public string prop1

 

See Also