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


<list> (Visual C++)

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

<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 (Visual C++)