Поделиться через

<list> и <listheader> теги документации

  • Статья

Блок <listheader> используется для определения строки заголовка в таблице или списке определений. При определении таблицы необходимо ввести данные для термина в заголовке.

Синтаксис

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

Параметры

term
Термин, который будет определен в description.

description
Либо элемент маркированного или нумерованного списка, либо определение term.

Замечания

Каждый элемент в списке указывается в блоке <item>. При создании списка определений необходимо указать одновременно term и description. Тем не менее для таблицы, маркированного или нумерованного списка достаточно ввести только description.

Число блоков <item> в списке или таблице не ограничено.

Скомпилируйте их для /doc обработки примечаний документации к файлу.

Пример

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

См. также

XML-документация