<list> i <listheader> tagi dokumentacji

Blok <listheader> służy do definiowania wiersza nagłówka tabeli lub listy definicji. Podczas definiowania tabeli wystarczy podać wpis dla terminu w nagłówku.

Składnia

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

Parametry

term
Termin do zdefiniowania, który zostanie zdefiniowany w pliku description.

description
Element na liście punktowanej lub numerowanej albo definicja elementu term.

Uwagi

Każdy element na liście jest określony z blokiem <item> . Podczas tworzenia listy definicji należy określić wartości i term description. Jednak w przypadku tabeli, listy punktowanej lub listy numerowanej wystarczy podać wpis dla descriptionelementu .

Lista lub tabela może zawierać tyle <item> bloków, ile jest potrzebnych.

Skompiluj element , /doc aby przetworzyć komentarze dokumentacji do pliku.

Przykład

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

Zobacz też

Dokumentacja XML