<list> (Guide de programmation C#)

Mise à jour : novembre 2007

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

Paramètres

• term
  Terme à définir, qui est défini dans description.

• description
  Élément d'une liste à puces ou numérotée, ou définition d'un term.

Notes

Le bloc <listheader> permet de définir la ligne de titre d'un tableau ou d'une liste de définitions. Lorsque vous définissez un tableau, il suffit de fournir une entrée pour term dans le titre.

Chaque élément de la liste est spécifié par un bloc <item>. Lorsque vous créez une liste de définitions, vous devez spécifier à la fois term et description. Cependant, pour un tableau, une liste à puces ou une liste numérotée, il vous suffit de fournir une entrée pour description.

Une liste ou un tableau peut comporter autant de blocs <item> que nécessaire.

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

Exemple

// 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()
    {
    }
}

Voir aussi

Concepts

Guide de programmation C#

Référence

Balises recommandées pour commentaires de documentation (Guide de programmation C#)