<list> (Visual Basic)

Articolo
08/11/2011

Definisce un elenco o una tabella.

<list type="type">
   <listheader>
      <term>term</term>
      <description>description</description>
   </listheader>
   <item>
      <term>term</term>
      <description>description</description>
   </item>
</list>

Parametri

type
Tipo dell'elenco. Deve corrispondere a "bullet", "number" o "table" rispettivamente per un elenco puntato, numerato o una tabella a due colonne.
term
Utilizzato solo quando type è "table". Termine da definire, definito nel tag di descrizione.
description
Quando il parametro type è "bullet" o "number", description è una voce dell'elenco. Quando invece type è "table", description corrisponde alla definizione di term.

Note

Il blocco <listheader> definisce l'intestazione di una tabella o di un elenco di definizioni. Per definire una tabella, è sufficiente specificare una voce per il parametro term 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 tutti i blocchi <item> necessari.

Eseguire la compilazione con /doc per elaborare in un file i commenti relativi alla documentazione.

Esempio

In questo esempio il tag <list> viene utilizzato per definire un elenco puntato nella sezione relativa alle note.

''' <remarks>Before calling the <c>Reset</c> method, be sure to:
''' <list type="bullet">
''' <item><description>Close all connections.</description></item>
''' <item><description>Save the object state.</description></item>
''' </list>
''' </remarks>
Public Sub Reset()
    ' Code goes here.
End Sub

Vedere anche

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)

Condividi tramite