十個必備的.NET開發小工具(7):NDoc

來源:互聯網
上載者:User
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檔案,因而以快速和有效方式自動完成了煩人的任務。



相關文章

E-Commerce Solutions

Leverage the same tools powering the Alibaba Ecosystem

Learn more >

11.11 Big Sale for Cloud

Get Unbeatable Offers with up to 90% Off,Oct.24-Nov.13 (UTC+8)

Get It Now >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。