NDoc



編寫(xiě)代碼文檔一直是一項(xiàng)令人生畏的任務(wù)。這里我并不是指設(shè)計(jì)初期的文檔或更為詳細(xì)的設(shè)計(jì)文檔，而是指類(lèi)中方法和屬性的文檔。NDoc工具能使用反射檢查程序集并使用從C# XML注釋生成的XML文檔自動(dòng)為你的代碼生成文檔。目前只有C#提供XML注釋?zhuān)�但利用Visual Studio .NET小工具VB Commenter 可以使Visual Basic .NET具有XML注釋功能。另外，Visual Studio的下一個(gè)發(fā)布版本將對(duì)更多的語(yǔ)言支持XML注釋。



利用NDoc，你很容易在編寫(xiě)代碼的同時(shí)形成文檔（在XML注釋中）。要使用NDoc，首先要在Visual Studio.NET中打開(kāi)程序集的XML注釋生成功能。右鍵點(diǎn)擊項(xiàng)目，選擇Properties Configuration Properties Build ，然后在“XML Documentation File”項(xiàng)中輸入保存XML文件的路徑。當(dāng)項(xiàng)目編譯時(shí)，就會(huì)創(chuàng)建一個(gè)包括所有XML注釋的XML文件。下面是NUnit范例中一個(gè)方法的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并進(jìn)行匹配。NDoc可使用該數(shù)據(jù)創(chuàng)建各種不同的文檔格式，包括MSDN風(fēng)格的HTML幫助文件格式（.chm）、Visual Studio .NET 幫助文件格式（HTML Help 2）等。生成XML文件之后，下一步是將程序集和XML文件加載到NDoc中以便進(jìn)行處理。操作很簡(jiǎn)單，只需打開(kāi)NDoc并點(diǎn)擊“Add”按鈕，然后添加相關(guān)文件即可。



一旦程序集和XML文件載入NDoc中并根據(jù)屬性范圍定制輸出后，點(diǎn)擊“Generate”按鈕就開(kāi)始生成文檔。使用默認(rèn)屬性，NDoc會(huì)生成一些非常有用的.html和.chm文件，因而以快速和有效的方式自動(dòng)完成了煩人的任務(wù)。