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

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

1.ADB介紹

    程式的註釋在程式的編寫和維護中扮演著相當重要的角色，在Visual C#中，可以為程式碼建立文件，方法是在XML標記所指的程式碼塊前面，直接在原始碼的特殊註釋欄位中包括XML 標記。編譯器編譯時將在原始碼中搜索所有的 XML 標記，並建立一個XML文件檔案。.NET文件生成工具(

    注意：使用該軟體需先安裝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等等。如果想做很完善的幫助文件，那這些細節處理得越好，那文件的作用就越強大。

2.2 專案設定與生成

    專案編譯之前，要確認是否生成xml檔案，開啟 專案屬性->生成->輸出 節點，如下圖：

    確認勾選xml文件檔案選項。生成的時候就是根據這個xml的註釋來進行的。

2.3 ADB使用生成CHM文件

    開啟ADB軟體，我在第3節提供2個版本的下載，如果需要自己編譯其他版本，開啟ADB軟體,如下圖：

    輸入標題後，新增你要生成的文件的dll檔案，可以新增多個，然後如果你生成了對應的xml檔案，會自動載入進來。否則會報錯。如下圖：

    還可以只新增你想要的型別以及方法。一般非公共型別可以不加進去。最後點”建立文件”就OK了，它會生成到你xml檔案的目錄。

注意2個小問題：你的CHM的檔案標題要規範一點，什麼#號，：號等都不要加上去，否則會報錯，有時候很頭疼。。。經常會忘記這一個，有時候還不止咋搞，就錯誤。如下圖所示，標題就有問題：

    好了，不說了，說多了都是淚。下面看看我生成的一些文件：

    效果不錯哦。。。趕緊試試。

3.資源與程式碼

    我這裡發的是X元件修改版本的原始碼，感謝@盧春城 ，@大石頭，我只是打醬油的，把它分享出來而已。

大家主要，如果dll不是上面2個版本，可能要自己編譯一下。如果有問題，及時留言，我會給大家解決，可能有一些小問題。因為我安裝好後，基本生成都是好的。沒碰到過啥問題，不保證大家也麼有問題啊。非常感謝 發現一個問題：