<list> (Visual C++)

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