標籤名稱瀏覽器 |
說明編碼 |
語法spa |
參數線程 |
<summary>code |
<summary> 標記應當用於描述類型或類型成員。使用<remarks> 添加針對某個類型說明的補充信息。對象 <summary> 標記的文本是惟一有關 IntelliSense 中的類型的信息源,它也顯示在 對象瀏覽器 中。索引 |
<summary>事件 Description圖片 </summary>ip |
description:對象的摘要。 |
<remarks> |
使用 <remarks> 標記添加有關類型的信息,以此補充用<summary> 指定的信息。此信息顯示在對象瀏覽器中。 |
<remarks> Description </remarks> |
description:成員的說明。 |
<param> |
<param> 標記應當用於方法聲明的註釋中,以描述方法的一個參數。 有關 <param> 標記的文本將顯示在 IntelliSense、對象瀏覽器和代碼註釋 Web 報表中。 |
<param name='name'> description </param> |
name:方法參數名。將此名稱用雙引號括起來 (" ")。 description:參數說明。 |
<returns> |
<returns> 標記應當用於方法聲明的註釋,以描述返回值。 |
<returns> Description </returns> |
description:返回值的說明。 |
<value> |
<value> 標記使您得以描述屬性所表明的值。請注意,當在Visual Studio .NET 開發環境中經過代碼嚮導添加屬性時,它將會爲新屬性添加<summary> 標記。而後,應該手動添加 <value> 標記以描述該屬性所表示的值。 |
<value> property-description </value> |
property-description:屬性的說明 |
<example> |
使用 <example> 標記能夠指定使用方法或其餘庫成員的示例。這一般涉及使用 <code> 標記。 |
<example> Description </example> |
description: 代碼示例的說明。 |
<c> |
<c> 標記爲您提供了一種將說明中的文本標記爲代碼的方法。使用 <code> 將多行指示爲代碼。 |
<c> Text </c> |
text :但願將其指示爲代碼的文本。 |
<code> |
使用 <code> 標記將多行指示爲代碼。使用<c>指示應將說明中的文本標記爲代碼。 |
<code> Content </code> |
content:但願將其標記爲代碼的文本。 |
<exception> |
<exception> 標記使您能夠指定哪些異常可被引起。此標記可用在方法、屬性、事件和索引器的定義中。 |
<exception cref="member"> Description </exception> |
cref: 對可從當前編譯環境中獲取的異常的引用。編譯器檢查到給定異常存在後,將member 轉換爲輸出XML 中的規範化元素名。必須將 member括在雙引號 (" ")中。 有關如何建立對泛型類型的 cref 引用的更多信息,請參見<see> description:異常的說明。 |
<see> <seealso> |
<see> 標記使您得以從文本內指定連接。使用 <seealso> 指示文本應該放在「另請參見」節中。 |
<see cref="member"/> |
cref: 對能夠經過當前編譯環境進行調用的成員或字段的引用。編譯器檢查給定的代碼元素是否存在,並將member 傳遞給輸出XML 中的元素名稱。應將 member 放在雙引號 (" ") 中。 |
<para> |
<para> 標記用於諸如<summary>,<remarks> 或<returns> 等標記內,使您得以將結構添加到文本中。 |
<para>content</para> |
content:段落文本。 |
<code>* |
提供了一種插入代碼的方法。 |
<code src="src"language="lan"encoding="c"/> |
src:代碼文件的位置 language:代碼的計算機語言 encoding:文件的編碼 |
<img>* |
用以在文檔中插入圖片 |
<img src="src"/> |
src:圖片的位置,相對於註釋所在的XML文件 |
<file>* |
用以在文檔中插入文件,在頁面中表現爲下載連接 |
<file src="src"/> |
src:文件的位置,相對於註釋所在的XML文件 |
<localize>* |
提供一種註釋本地化的方法,名稱與當前線程語言不一樣的子節點將被忽略 |
<localize> <zh-CHS>中文</zh-CHS> <en>English</en> ... </localize> |