Export (0) Print
Expand All

<list>

<list type="bullet" | "number" | "table">
   <listheader>
      <term>term</term>
      <description>description</description>
   </listheader>
   <item>
      <term>term</term>
      <description>description</description>
   </item>
</list>

where:

term
A term to define, which will be defined in text.
description
Either an item in a bullet or numbered list or the definition of a term.

Remarks

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 text. However, for a table, bulleted list, or numbered list, you only need to supply an entry for text.

A list or table can have as many <item> blocks as needed.

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

Example

// xml_list_tag.cs
// compile with: /doc:xml_list_tag.xml 

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

See Also

Recommended Tags for Documentation Comments

Show:
© 2014 Microsoft