<list>
和 <listheader>
文件標籤
<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 {};