<list> (Visual Basic)

Définit une liste ou une table.

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 « puce » pour une liste à puces, « nombre » pour une liste numérotée ou « table » pour une table à deux colonnes.

term
Utilisé uniquement lorsqu’il type s’agit de « table ». Terme à définir, qui est défini dans la balise de description.

description
Quand type est « puce » ou « nombre », description est un élément de la liste Quand type est « table », description est la définition de term.

Remarques

Le <listheader> bloc définit l’en-tête d’une liste de tables ou de définitions. Lors de la définition d’une table, vous devez uniquement fournir une entrée dans term le titre.

Chaque élément de la liste est spécifié avec un bloc <item>. Lors de la création d’une liste de définitions, vous devez spécifier à la fois term et description. Toutefois, pour une table, une liste à puces ou une liste numérotée, vous devez uniquement fournir une entrée pour description.

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

Compilez avec -doc pour traiter les commentaires de documentation dans un fichier.

Exemple :

Cet exemple utilise la <list> balise 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

Voir aussi

• Balises XML pour les commentaires