<list> značky <listheader> dokumentace

Blok <listheader> slouží k definování řádku záhlaví tabulky nebo seznamu definic. Při definování tabulky stačí zadat položku pro termín v záhlaví.

Syntaxe

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

Parametry

term
Termín k definování, který bude definován v description.

description
Položka v seznamu s odrážkami nebo číslovaným seznamem nebo definice term.

Poznámky

Každá položka v seznamu je určena blokem <item> . Při vytváření seznamu definic budete muset zadat obojí term i description. Pro tabulku, seznam s odrážkami nebo číslovaný seznam však stačí zadat položku pro description.

Seznam nebo tabulka můžou mít libovolný počet <item> bloků.

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad

// 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 {};

Viz také

Dokumentace XML