文檔型注釋
創(chuàng)新互聯(lián)是一家集網(wǎng)站建設(shè),鹽亭企業(yè)網(wǎng)站建設(shè),鹽亭品牌網(wǎng)站建設(shè),網(wǎng)站定制,鹽亭網(wǎng)站建設(shè)報(bào)價(jià),網(wǎng)絡(luò)營(yíng)銷,網(wǎng)絡(luò)優(yōu)化,鹽亭網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè),幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強(qiáng)企業(yè)競(jìng)爭(zhēng)力??沙浞譂M足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時(shí)我們時(shí)刻保持專業(yè)、時(shí)尚、前沿,時(shí)刻以成就客戶成長(zhǎng)自我,堅(jiān)持不斷學(xué)習(xí)、思考、沉淀、凈化自己,讓我們?yōu)楦嗟钠髽I(yè)打造出實(shí)用型網(wǎng)站。
該類注釋采用.Net已定義好的Xml標(biāo)簽來(lái)標(biāo)記,在聲明接口、類、方法、屬性、字段都應(yīng)該使用該類注釋,以便代碼完成后直接生成代碼文檔,讓別人更好的了解代碼的實(shí)現(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)
{
}
注釋標(biāo)簽*
標(biāo)簽 | 作用 | 用法 |
<param> | <param name='name'>description</param> name 為方法參數(shù)名。將此名稱用單引號(hào)括起來(lái)(' ')。 | 應(yīng)當(dāng)用于方法聲明的注釋中,以描述方法的一個(gè)參數(shù)。 |
<see> | <see cref="member"/> cref = "member" 對(duì)可以通過(guò)當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后,將 member 傳遞給輸出XML 中的元素名。必須將 member 括在雙引號(hào) (" ") 中。 | 使您得以從文本內(nèi)指定鏈接 |
<seealso> | <seealso cref="member"/> cref = "member" 對(duì)可以通過(guò)當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后,將 member 傳遞給輸出XML 中的元素名。必須將 member 括在雙引號(hào) (" ") 中 | |
<example> | <example>description</example> description代碼示例的說(shuō)明。 | 使用 <example>標(biāo)記可以指定使用方法或其他庫(kù)成員的示例。一般情況下,這將涉及到<code>標(biāo)記的使用。 |
<include> | <include file='filename' path='tagpath[@name="id"]' /> filename 包含文檔的文件名。該文件名可用路徑加以限定。將 filename 括在單引號(hào)中 (' ')。 Tagpath:filename 中指向標(biāo)記名的標(biāo)記路徑。將此路徑括在單引號(hào)中 (' ')。 name 注釋前邊的標(biāo)記中的名稱說(shuō)明符;名稱具有一個(gè) id。 id 位于注釋之前的標(biāo)記的 id。將此 id 括在雙引號(hào)中 (" ")。 | <include> 標(biāo)記使您得以引用描述源代碼中類型和成員的另一文件中的注釋。這是除了將文檔注釋直接置于源代碼文件中之外的另一種可選方法。 <include> 標(biāo)記使用 XML XPath 語(yǔ)法。有關(guān)自定義 <include> 使用的方法,請(qǐng)參閱 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 定義的項(xiàng),該項(xiàng)將在 text 中定義。 description 目符號(hào)列表或編號(hào)列表中的項(xiàng)或者 term 的定義。 | <listheader> 塊用于定義表或定義列表中的標(biāo)題行。定義表時(shí),只需為標(biāo)題中的項(xiàng)提供一個(gè)項(xiàng)。 列表中的每一項(xiàng)用 <item> 塊指定。創(chuàng)建定義列表時(shí),既需要指定 term 也需要指定 text。但是,對(duì)于表、項(xiàng)目符號(hào)列表或編號(hào)列表,只需為 text 提供一個(gè)項(xiàng)。 列表或表所擁有的 <item> 塊數(shù)可以根據(jù)需要而定。 |
<permission> | <permissioncref="member">description</permission> cref = "member" 對(duì)可以通過(guò)當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后,將 member 轉(zhuǎn)換為輸出XML 中的規(guī)范化元素名。必須將 member 括在雙引號(hào) (" ") 中。 description 成員的訪問(wèn)的說(shuō)明。 | <permission>標(biāo)記使您得以將成員的訪問(wèn)記入文檔。System.Security.PermissionSet 使您得以指定對(duì)成員的訪問(wèn)。 |
<remarks> | <remarks>description</remarks> description 成員的說(shuō)明。 | |
<value> | <value>property-description</value> property-description 屬性的說(shuō)明。 |
名稱欄目:C#注釋標(biāo)簽
文章位置:http://www.muchs.cn/article4/jpjeie.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供用戶體驗(yàn)、虛擬主機(jī)、做網(wǎng)站、全網(wǎng)營(yíng)銷推廣、標(biāo)簽優(yōu)化、微信小程序
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)