<liste> (Visual Basic)
Définit une liste ou un tableau.
Syntaxe
<list type="type">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
Paramètres
type
Type de la liste. Doit être une « bullet » pour une liste à puces, « number » pour une liste numérotée ou « table » pour une table à deux colonnes.
term
Utilisé uniquement quand type est « table ». Terme à définir, qui est défini dans la balise de description.
description
Quand type est « bullet » ou « number », description est un élément de la liste. Quand type est « table », description est la définition de term.
Notes
Le bloc <listheader> définit l’en-tête d’une liste de tables ou de définitions. Au moment de définir une table, il vous suffit de fournir une entrée pour term figurant dans l’en-tête.
Chaque élément de la liste est spécifié avec un bloc <item>. Au moment de créer une liste de définitions, vous devez spécifier à la fois term et description. Cependant, pour une table, une liste à puces ou une liste numérotée, il vous suffit de fournir une entrée pour description.
Une liste ou une table peut comporter autant de blocs <item> que nécessaire.
Compilez avec -doc pour placer les commentaires de documentation dans un fichier en vue de les traiter.
Exemple
Cet exemple utilise la balise <list> pour définir une liste à puces dans la section remarques.
''' <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
