<list> (Visual Basic)
定义列表或表。
语法
<list type="type">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
parameters
type
列表的类型。 对于项目符号列表必须是“bullet”,对于编号列表必须是“number”,对于两列表必须是“table”。
term
仅在 type
为“table”时使用。要定义的术语,在描述标签中定义。
description
当 type
为“bullet”或“number”时,description
是列表中的一个项,当 type
为“table”时,description
是 term
的定义。
注解
<listheader>
块用于定义表或定义列表的标题。 定义表时,只需为标题中的 term
提供条目。
列表中的每个项均使用 <item>
块指定。 创建定义列表时,必须同时指定 term
和 description
。 但是,对于表、项目符号列表或编号列表,只需为 description
提供条目。
列表或表可根据需要具有多个 <item>
块。
使用 -doc 进行编译以便将文档注释处理到文件中。
示例
此示例使用 <list>
标记在注释部分定义项目符号列表。
''' <remarks>Before calling the <c>Reset</c> method, be sure to:
''' <list type="bullet">
''' <item><description>Close all connections.</description></item>
''' <item><description>Save the object state.</description></item>
''' </list>
''' </remarks>
Public Sub Reset()
' Code goes here.
End Sub