定义列表或表。
语法
<list type="type">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
参数
type
列表的类型。 必须为项目符号列表的“项目符号”、编号列表的“number”或双列表的“table”。
term
仅当为“table”时才 type
使用。要定义的术语,在说明标记中定义。
description
如果 type
为“项目符号”或“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