新聞中心
本文主要講述VS XML注釋?zhuān)鯓邮窃创a插入VS XML注釋?zhuān)绾伟裋S XML注釋輸出為有用文檔,這些內(nèi)容都是一些門(mén)戶網(wǎng)站和技術(shù)論壇找到的,歡迎大家學(xué)習(xí)切磋交流。。

成都創(chuàng)新互聯(lián)從2013年開(kāi)始,是專(zhuān)業(yè)互聯(lián)網(wǎng)技術(shù)服務(wù)公司,擁有項(xiàng)目網(wǎng)站制作、成都網(wǎng)站制作網(wǎng)站策劃,項(xiàng)目實(shí)施與項(xiàng)目整合能力。我們以讓每一個(gè)夢(mèng)想脫穎而出為使命,1280元當(dāng)陽(yáng)做網(wǎng)站,已為上家服務(wù),為當(dāng)陽(yáng)各地企業(yè)和個(gè)人服務(wù),聯(lián)系電話:028-86922220
C# 允許開(kāi)發(fā)人員在源代碼中插入VS XML注釋?zhuān)@在多人協(xié)作開(kāi)發(fā)的時(shí)候顯得特別有用。 C#解析器可以把代碼文件中的這些XML標(biāo)記提取出來(lái),并作進(jìn)一步的處理為外部文檔。 這篇文章將展示如何使用這些VS XML注釋。作者演示了如何生成工程,如何把VS XML注釋輸出為有用文檔,如何把這些注釋轉(zhuǎn)變?yōu)閹椭募?在項(xiàng)目開(kāi)發(fā)中,很多人并不樂(lè)意寫(xiě)繁雜的文檔。
但是,開(kāi)發(fā)組長(zhǎng)希望代碼注釋盡可能詳細(xì);項(xiàng)目規(guī)劃人員希望代碼設(shè)計(jì)文檔盡可能詳盡;測(cè)試、檢查人員希望功能說(shuō)明書(shū)盡可能詳細(xì)等等。 如果這些文檔都被要求寫(xiě)的話,保持它們同步比進(jìn)行一個(gè)戰(zhàn)役還痛苦。 #t#
為何不把這些信息保存在一個(gè)地方呢??最明顯想到的地方就是代碼的注釋中;但是你很難通覽程序,并且有些需要這些文檔的人并不懂編碼。
這篇文章將展示如何通過(guò)使用VS XML注釋來(lái)解決這些問(wèn)題。代碼注釋、用戶手冊(cè)、開(kāi)發(fā)人員手冊(cè)、測(cè)試計(jì)劃等很多文檔可以很方便的從VS XML注釋中獲得。我將先演示如何插入XML注釋、如何把這些XML注釋導(dǎo)出為另一個(gè)文檔。然后再討論每個(gè)XML標(biāo)記的意思,以及使用XML和XSL生成幫助文件。
所有的XML注釋都在三個(gè)向前的斜線之后(///)。兩條斜線表示是一個(gè)注釋?zhuān)幾g器將忽略后面的內(nèi)容。三條斜線告訴編譯器,后面是VS XML注釋?zhuān)枰m當(dāng)?shù)靥幚怼?/p>
當(dāng)開(kāi)發(fā)人員輸入三個(gè)向前的斜線后,Microsoft Visual Studio .NET IDE 自動(dòng)檢查它是否在類(lèi)或者類(lèi)成員的定義的前面。如果是的話,Visual Studio .NET IDE 將自動(dòng)插入注釋標(biāo)記,開(kāi)發(fā)人員只需要增加些額外的標(biāo)記和值。下面就是在成員函數(shù)前增加三個(gè)斜線,自動(dòng)增加的注釋。代碼如下:
- ///
- ///
- ///
- /// name="strFilePath">
- public void LoadXMLFromFile(string strFilePath)
分享文章:如何插入VSXML注釋代碼
標(biāo)題路徑:http://www.fisionsoft.com.cn/article/djjcsoj.html


咨詢
建站咨詢
