<list> (Visual Basic)

  • Article

Définit une liste ou une table.

<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, "numéro" pour une liste numérotée, ou "table" pour une table à deux colonnes.

  • term
    Utilisé uniquement lorsque type est « table ». Terme à définir qui est défini dans la balise de description.

  • description
    Lorsque type est « puce » ou « numéro », description est un élément dans la liste. Lorsque type est « table », description est la définition de term.

Notes

Le bloc <listheader> permet de définir le titre d'une table ou d'une liste de définitions.Lorsque vous définissez une table, il suffit de fournir une entrée pour term dans le titre.

Chaque élément de la liste est spécifié dans un bloc <item>.Lorsque vous créez 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 traiter les commentaires de documentation et les placer dans un fichier.

Exemple

Cet exemple utilise la balise <list> pour définir une liste à puces dans la section Notes.

''' <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

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)