文檔型注釋
該類注釋采用.Net已定義好的Xml標簽來標記,在聲明接口、類、方法、屬性、字段都應(yīng)該使用該類注釋,以便代碼完成后直接生成代碼文檔,讓別人更好的了解代碼的實現(xiàn)和接口。如
///<summary>MyMethod is a method in the MyClass class.
///<para>Here's how you could make a second paragraph in a description.
///<see cref="System.Console.WriteLine"/>
///for information about output statements.
///</para>
///<seealso cref="MyClass.Main"/>
///</summary>
public static void MyMethod(int Int1)
{
}
注釋標簽*
標簽 | 作用 | 用法 |
<param> | <param name='name'>description</param> name 為方法參數(shù)名。將此名稱用單引號括起來(' ')。 | 應(yīng)當用于方法聲明的注釋中,以描述方法的一個參數(shù)。 |
<see> | <see cref="member"/> cref = "member" 對可以通過當前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后,將 member 傳遞給輸出XML 中的元素名。必須將 member 括在雙引號 (" ") 中。 | 使您得以從文本內(nèi)指定鏈接 |
<seealso> | <seealso cref="member"/> cref = "member" 對可以通過當前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后,將 member 傳遞給輸出XML 中的元素名。必須將 member 括在雙引號 (" ") 中 | |
<example> | <example>description</example> description代碼示例的說明。 | 使用 <example> 標記可以指定使用方法或其他庫成員的示例。一般情況下,這將涉及到 <code>標記的使用。 |
<include> | <include file='filename' path='tagpath[@name="id"]' /> filename 包含文檔的文件名。該文件名可用路徑加以限定。將 filename 括在單引號中 (' ')。 Tagpath:filename 中指向標記名的標記路徑。將此路徑括在單引號中 (' ')。 name 注釋前邊的標記中的名稱說明符;名稱具有一個 id。 id 位于注釋之前的標記的 id。將此 id 括在雙引號中 (" ")。 | <include> 標記使您得以引用描述源代碼中類型和成員的另一文件中的注釋。這是除了將文檔注釋直接置于源代碼文件中之外的另一種可選方法。 <include> 標記使用 XML XPath 語法。有關(guān)自定義 <include> 使用的方法,請參閱 XPath 文檔。 |
<list> | <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> 塊用于定義表或定義列表中的標題行。定義表時,只需為標題中的項提供一個項。 列表中的每一項用 <item> 塊指定。創(chuàng)建定義列表時,既需要指定 term 也需要指定 text。但是,對于表、項目符號列表或編號列表,只需為 text 提供一個項。 列表或表所擁有的 <item> 塊數(shù)可以根據(jù)需要而定。 |
<permission> | <permissioncref="member">description</permission> cref = "member" 對可以通過當前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后,將 member 轉(zhuǎn)換為輸出XML 中的規(guī)范化元素名。必須將 member 括在雙引號 (" ") 中。 description 成員的訪問的說明。 | <permission> 標記使您得以將成員的訪問記入文檔。System.Security.PermissionSet 使您得以指定對成員的訪問。 |
<remarks> | <remarks>description</remarks> description 成員的說明。 | |
<value> | <value>property-description</value> property-description 屬性的說明。 |
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內(nèi)外云服務(wù)器15元起步,三天無理由+7*72小時售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機、免備案服務(wù)器”等云主機租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價比高”等特點與優(yōu)勢,專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
網(wǎng)站標題:C#注釋標簽-創(chuàng)新互聯(lián)
當前URL:http://jinyejixie.com/article10/hiego.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供靜態(tài)網(wǎng)站、搜索引擎優(yōu)化、App開發(fā)、網(wǎng)頁設(shè)計公司、小程序開發(fā)、營銷型網(wǎng)站建設(shè)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容