NDoc 用户指南   [回目录] NDoc 1.3

<list>

[此文档为预发布版本,在未来版本中有可能改变。]

<list> 标记表示一个列表(数字列表或符号列表),或一个表格,或一个定义表。Block 标记。

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

其中:

term
要定义的项,该项将在 description 中说明/定义。
description
term 的说明/定义。

备注

<list> 可以表示为四种样式:bullet 为符号列表,即对应于 HTML 中的 UL 列表;number 为数字列表,即对应于 HTML 中的 OL 列表;table 为表格,将以表格形式表示;definition 为定义列表,显示效果就像本页上方“其中”二字下面对 termdescription 的定义那样。

<listheader> 对 table 和 definition 有效。对 table,需要为 termdescription 两列分别指定列标题。对 definition,需要指定标题文本,如本页上方的“其中:”那一行。

<item> 块表示列表中的一项。item 包含子元素 termdescription。对 bullet 和 number 列表,term 无效也不需要写。对 table 表,可以没有 term,只写 description。对 definition 表,termdescription 都应该有。

列表可以根据需要包含多个 <item> 块。

示例

请参见

标记用法 | NDoc 支持的标记 | Microsoft 的定义