<list> (C# programming guide)


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


  • term

    A term to define, which will be defined in description.

  • description

    Either an item in a bullet or numbered list or the definition of a term.


The <listheader> block is used to define the heading row of either a table or definition list. 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.

Compile with -doc to process documentation comments to a file.


// compile with: -doc:DocFileName.xml

/// text for class TestClass
public class TestClass
    /// <summary>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    static void Main()

See also