NDoc的使用說明！

作者：James Avery 翻譯：lucentoff

出處：http://msdn.microsoft.com/msdnmag/issues/04/07/MustHaveTools/default.aspx

聲明：版權屬原作者所有，轉載請註明出處！


--------------------------------------------------------------------------------


NDoc



編寫代碼文檔一直是一項令人生畏的任務。這裏我並不是指設計初期的文檔或更爲詳細的設計文檔，而是指類中方法和屬性的文檔。NDoc工具能使用反射檢查程序集並使用從C# XML註釋生成的XML文檔自動爲你的代碼生成文檔。目前只有C#提供XML註釋，但利用Visual Studio .NET小工具VB Commenter 可以使Visual Basic .NET具有XML註釋功能。另外，Visual Studio的下一個發佈版本將對更多的語言支持XML註釋。



利用NDoc，你很容易在編寫代碼的同時形成文檔（在XML註釋中）。要使用NDoc，首先要在Visual Studio.NET中打開程序集的XML註釋生成功能。右鍵點擊項目，選擇Properties | Configuration Properties | Build ，然後在“XML Documentation File”項中輸入保存XML文件的路徑。當項目編譯時，就會創建一個包括所有XML註釋的XML文件。下面是NUnit範例中一個方法的XML文檔：

///
/// This test adds a number of values to the Hashtable collection
/// and then retrieves those values and checks if they match.
///
[Test]
public void HashtableAddTest()
{
//Method Body Here
}

該方法的XML文檔將被抽取並保存到XML文件中，如下所示：


This test adds a number of values to the Hashtable collection
and then retrieves those values and checks if they match.


NDoc利用反射查看程序集，然後讀取文檔中的XML並進行匹配。NDoc可使用該數據創建各種不同的文檔格式，包括MSDN風格的HTML幫助文件格式（.chm）、Visual Studio .NET 幫助文件格式（HTML Help 2）等。生成XML文件之後，下一步是將程序集和XML文件加載到NDoc中以便進行處理。操作很簡單，只需打開NDoc並點擊“Add”按鈕，然後添加相關文件即可。



一旦程序集和XML文件載入NDoc中並根據屬性範圍定製輸出後，點擊“Generate”按鈕就開始生成文檔。使用默認屬性，NDoc會生成一些非常有用的.html和.chm文件，因而以快速和有效的方式自動完成了煩人的任務。



NDoc是一個開源項目，下載網址：http://NDoc.sourceforge.net/。