本文主要講述VS XML注釋，怎樣是源代碼插入VS XML注釋，如何把VS XML注釋輸出為有用文檔，這些內(nèi)容都是一些門戶網(wǎng)站和技術(shù)論壇找到的，歡迎大家學(xué)習(xí)切磋交流。。

C# 允許開(kāi)發(fā)人員在源代碼中插入VS XML注釋，這在多人協(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è)意寫繁雜的文檔。

但是，開(kāi)發(fā)組長(zhǎng)希望代碼注釋盡可能詳細(xì)；項(xiàng)目規(guī)劃人員希望代碼設(shè)計(jì)文檔盡可能詳盡；測(cè)試、檢查人員希望功能說(shuō)明書盡可能詳細(xì)等等。 如果這些文檔都被要求寫的話，保持它們同步比進(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è)注釋，編譯器將忽略后面的內(nèi)容。三條斜線告訴編譯器，后面是VS XML注釋，需要適當(dāng)?shù)靥幚怼?/P>

當(dāng)開(kāi)發(fā)人員輸入三個(gè)向前的斜線后，Microsoft Visual Studio .NET IDE 自動(dòng)檢查它是否在類或者類成員的定義的前面。如果是的話，Visual Studio .NET IDE 將自動(dòng)插入注釋標(biāo)記，開(kāi)發(fā)人員只需要增加些額外的標(biāo)記和值。下面就是在成員函數(shù)前增加三個(gè)斜線，自動(dòng)增加的注釋。代碼如下：

/// <summary> 
///  
/// </summary> 
/// <param name="strFilePath"></param> 
public void LoadXMLFromFile(string strFilePath)