<list> et <listheader> balises de documentation
Le bloc <listheader> est utilisé pour définir la ligne d’en-tête d’une table ou d’une liste de définitions. Au moment de définir une table, il vous suffit de fournir une entrée pour le terme figurant dans l’en-tête.
Syntaxe
<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 contenu dans une puce ou une liste numérotée ou définition d’un term.
Notes
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 traiter les commentaires de documentation 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 {};