<list> (Visual Basic)
Definisce un elenco o una tabella.
Sintassi
<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 essere "bullet" per un elenco puntato, "number" per un elenco numerato o "table" per una tabella a due colonne.
term
Usato solo quando type
è "table". Termine da definire, definito nel tag description.
description
Quando type
è "bullet" o "number", description
è un elemento dell'elenco Quando type
è "table", description
è la definizione di term
.
Osservazioni:
Il blocco <listheader>
definisce l'intestazione di una tabella o di un elenco di definizioni. Per definire una tabella, è sufficiente specificare una voce per term
nell'intestazione.
Ogni 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>
.
Compilare con -doc per elaborare i commenti relativi alla documentazione in un file.
Esempio
In questo esempio viene usato il tag <list>
per definire un elenco puntato nella sezione commenti.
''' <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