Partager via


<list> (Visual C++)

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

<list type="bullet" | "number" | "table">
   <listheader>
      <term>term</term>
      <description>description</description>
   </listheader>
   <item>
      <term>term</term>
      <description>description</description>
   </item>
</list>

Paramètres

  • term
    Terme à définir, qui est défini dans description.

  • description
    Élément d'une liste à puces ou numérotée, ou définition d'un term.

Notes

Chaque élément de la liste est spécifié par un bloc <item>.Lorsque vous créez une liste de définitions, vous devez spécifier à la fois term et description.Cependant, pour un tableau, une liste à puces ou une liste numérotée, il vous suffit de fournir une entrée pour description.

Une liste ou un tableau 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

// xml_list_tag.cpp
// compile with: /doc /LD
// post-build command: xdcmake xml_list_tag.dll
/// <remarks>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </remarks>
class MyClass {};

Voir aussi

Autres ressources

Documentation XML (Visual C++)