很久以前就使用adb這個工具來生成項目的幫助文檔。功能強大,在學習一些開源項目的過程中,官方沒有提供chm幫助文檔,是以為了快速的了解項目結構和注釋。就生成文檔來自己看,非常好用。這也是一個學習方法吧。例如本文在:
<a href="http://www.cnblogs.com/asxinyu/p/dotnet_opensource_project_comparenet.html">.net平台開源項目速覽(2)compare .net objects對象比較元件</a>
<a href="http://www.cnblogs.com/asxinyu/p/dotnet_opensource_project_litedb.html">.net平台開源項目速覽(3)小巧輕量級nosql檔案資料庫litedb</a>
上述2篇文章中最後的資源中就手動制作了chm幫助文檔。有時候我們還可以對源碼進行翻譯,再制作,效果還不錯。今天介紹的adb工具,我使用的是基于x元件的一個改進版。改進的細節我也不太清楚,反正非常好用。下面來看看介紹和使用方法。
程式的注釋在程式的編寫和維護中扮演着相當重要的角色,在visual c#中,可以為代碼建立文檔,方法是在xml标記所指的代碼塊前面,直接在源代碼的特殊注釋字段中包括xml 标記。編譯器編譯時将在源代碼中搜尋所有的 xml 标記,并建立一個xml文檔檔案。.net文檔生成工具(下文簡稱為adb)通過反射程式集及其代碼中的xml注釋來建立msdn形式的api文檔。
注意:使用該軟體需先安裝microsoft html help workshop,主要作用有:
(1)根據程式集及其對應的xml文檔檔案生成風格類似msdn的文檔,并打包為chm檔案;
(2)将多個程式集對應的文檔合并到一個文檔中;
(3)自動搜尋程式集及其引用的程式集對應的xml文檔(包括.net自帶的程式集,如:system.xml);
(4)靈活控制在文檔中顯示哪些成員(如:隻生成公共方法);
(5)界面友好,操作簡便。
(6)使用者可以根據自己的需要擴充xml标志;
(7)使用者可以根據自己的需要編寫自定義的文檔生成器。
adb官方提供的最新版是2.3,可以去上面的連結下載下傳最新版,我這裡分享的是@大石頭使用x元件重新編譯後的版本。
使用過程分為3個步驟:
adb代碼生成主要是根據項目的注釋來進行生成的。例如c#中注釋的标記:
當然還有更多的标記符号,例如example,code,see等等。如果想做很完善的幫助文檔,那這些細節處理得越好,那文檔的作用就越強大。
項目編譯之前,要确認是否生成xml檔案,打開 項目屬性->生成->輸出 節點,如下圖:

确認勾選xml文檔檔案選項。生成的時候就是根據這個xml的注釋來進行的。
打開adb軟體,我在第3節提供2個版本的下載下傳,如果需要自己編譯其他版本,打開adb軟體,如下圖:
輸入标題後,添加你要生成的文檔的dll檔案,可以添加多個,然後如果你生成了對應的xml檔案,會自動加載進來。否則會報錯。如下圖:
還可以隻添加你想要的類型以及方法。一般非公共類型可以不加進去。最後點”建立文檔”就ok了,它會生成到你xml檔案的目錄。
注意2個小問題:你的chm的檔案标題要規範一點,什麼#号,:号等都不要加上去,否則會報錯,有時候很頭疼。。。經常會忘記這一個,有時候還不止咋搞,就錯誤。如下圖所示,标題就有問題:
好了,不說了,說多了都是淚。下面看看我生成的一些文檔:
效果不錯哦。。。趕緊試試。
大多數人安裝html help workshop 會預設安在c盤,
我将 html help workshop 安裝到d盤時,生成時會報"系統找不到指定的檔案"。
在源碼裡,将createchm()方法中的
“_hhcprocess.startinfo.filename = _defaulthhcpath; ” ,_defaulthhcpath 改成 hhcpath 就可以正常生成了。