C#注釋標(biāo)簽-創(chuàng)新互聯(lián)

<param name='name'>description</param>

name 為方法參數(shù)名。將此名稱用單引號括起來(' ')。

<see cref="member"/>

cref = "member" 對可以通過當(dāng)前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出XML 中的元素名。必須將 member 括在雙引號 (" ") 中。

<seealso cref="member"/>

cref = "member" 對可以通過當(dāng)前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出XML 中的元素名。必須將 member 括在雙引號 (" ") 中

<example>description</example>

description代碼示例的說明。

<include file='filename' path='tagpath[@name="id"]' />

filename 包含文檔的文件名。該文件名可用路徑加以限定。將 filename 括在單引號中 (' ')。

Tagpath：filename 中指向標(biāo)記名的標(biāo)記路徑。將此路徑括在單引號中 (' ')。

name 注釋前邊的標(biāo)記中的名稱說明符；名稱具有一個 id。

id

位于注釋之前的標(biāo)記的 id。將此 id 括在雙引號中 (" ")。

<include> 標(biāo)記使您得以引用描述源代碼中類型和成員的另一文件中的注釋。這是除了將文檔注釋直接置于源代碼文件中之外的另一種可選方法。

<include> 標(biāo)記使用 XML XPath 語法。有關(guān)自定義 <include> 使用的方法，請參閱 XPath 文檔。

<list type="bullet" | "number" | "table">

<listheader>

<term>term</term>

<description>description</description>

</listheader>

<item>

<term>term</term>

<description>description</description>

</item>

</list>

term 定義的項，該項將在 text 中定義。

description 目符號列表或編號列表中的項或者 term 的定義。

<listheader> 塊用于定義表或定義列表中的標(biāo)題行。定義表時，只需為標(biāo)題中的項提供一個項。

列表中的每一項用 <item> 塊指定。創(chuàng)建定義列表時，既需要指定 term 也需要指定 text。但是，對于表、項目符號列表或編號列表，只需為 text 提供一個項。

列表或表所擁有的 <item> 塊數(shù)可以根據(jù)需要而定。

<permissioncref="member">description</permission>

cref = "member" 對可以通過當(dāng)前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 轉(zhuǎn)換為輸出XML 中的規(guī)范化元素名。必須將 member 括在雙引號 (" ") 中。

description 成員的訪問的說明。

<remarks>description</remarks>

description 成員的說明。

<value>property-description</value>

property-description 屬性的說明。