.NET文檔生成工具ADB

03-02

很久以前就使用ADB這個工具來生成項目的幫助文檔。功能強大，在學習一些開源項目的過程中，官方沒有提供CHM幫助文檔，所以為了快速的了解項目結構和注釋。就生成文檔來自己看，非常好用。這也是一個學習方法吧。例如本文在：

Compare.NET Objects對象比較組件

SharpConfig配置文件讀寫組件

上述2篇文章中最後的資源中就手動製作了CHM幫助文檔。有時候我們還可以對源碼進行翻譯，再製作，效果還不錯。今天介紹的ADB工具，我使用的是基於X組件的一個改進版。改進的細節我也不太清楚，反正非常好用。下面來看看介紹和使用方法。

1.ADB介紹

程序的注釋在程序的編寫和維護中扮演著相當重要的角色，在Visual C#中，可以為代碼創建文檔，方法是在XML標記所指的代碼塊前面，直接在源代碼的特殊注釋欄位中包括XML 標記。編譯器編譯時將在源代碼中搜索所有的 XML 標記，並創建一個XML文檔文件。.NET文檔生成工具(下文簡稱為ADB)通過反射程序集及其代碼中的XML注釋來創建MSDN形式的API文檔。

ADB文檔生成工具是博客園盧春城開發的一個開源工具，項目的介紹網址為：

http://www.cnblogs.com/lucc/archive/2008/09/01/1281085.html

注意：使用該軟體需先安裝Microsoft HTML Help Workshop，主要作用有：

(1)根據程序集及其對應的XML文檔文件生成風格類似MSDN的文檔，並打包為CHM文件；

(2)將多個程序集對應的文檔合併到一個文檔中；

(3)自動搜索程序集及其引用的程序集對應的XML文檔（包括.Net自帶的程序集,如：System.xml）；

(4)靈活控制在文檔中顯示哪些成員（如：只生成公共方法）；

(5)界面友好，操作簡便。

(6)用戶可以根據自己的需要擴展XML標誌；

(7)用戶可以根據自己的需要編寫自定義的文檔生成器。

ADB官方提供的最新版是2.3，可以去上面的鏈接下載最新版，我這裡分享的是@大石頭使用X組件重新編譯後的版本。

2.ADB生成.NET文檔過程

使用過程分為3個步驟：

2.1 .NET項目代碼注釋

ADB代碼生成主要是根據項目的注釋來進行生成的。例如C#中注釋的標記：

/// <summary>獲取指定數組中，滿足範圍的比例</summary>/// <param name="data">目標數據</param>/// <param name="L">下限</param>/// <param name="H">上限</param>public static double FindPrecent(this IEnumerable<Int32> data, Int32 L, Int32 H){ var t = (double)data.Where(n => n >= L && n <= H).Count(); return t / (double)data.Count(); }

當然還有更多的標記符號，例如example,code,see等等。如果想做很完善的幫助文檔，那這些細節處理得越好，那文檔的作用就越強大。