<list> (Guida per programmatori C#)

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

Parametri

• term
  Termine da definire, che verrà definito in description.

• description
  Elemento di un elenco puntato o numerato oppure la definizione di un term.

Note

Il blocco <listheader> viene utilizzato per definire la riga di intestazione di una tabella o di un elenco di definizioni. Per definire una tabella, è sufficiente specificare una voce per il termine nell'intestazione.

Ciascun elemento dell'elenco viene specificato tramite un blocco <item>. Quando si crea un elenco di definizioni, è necessario specificare sia term che description. Per le tabelle e gli elenchi puntati o numerati, tuttavia, è sufficiente fornire una voce per description.

Gli elenchi e le tabelle possono contenere un numero qualsiasi di blocchi <item>.

Eseguire la compilazione con /doc per elaborare in un file i commenti per la creazione della documentazione.

Esempio

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

Vedere anche

Riferimenti

Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)

Concetti

Guida per programmatori C#