生成幫助文件（html或chm格式）
Javadoc轉換chm幫助文件的四種方法總結
V1.0
目錄
|
李順利 |
|
[2010年1月6日] |
關鍵詞
Javadoc chm 轉換 jd2chm javadoc2chm javadoc2help Javadoc2chm 中文亂碼 李順利
前言
朋友，當您在一個專案完成後，是不是需要把你的原始碼打包並且把註釋打成Javadoc交給客戶，Eclipse或者MyEclipse自動打成的Javadoc文件都是基於網頁格式的，開啟是很方便，不過真的用的時候，搜尋每個方法或者什麼的就很麻煩了，而chm幫助文件格式不但檔案小，查閱都很方便，所以網上就出現了很多把
自己最近需要真的需要這個方面的需求，查閱了網上很多方法，發現很多都是寫的很不詳細，對於我這種剛接觸的很是不清楚，經過我的學習和理解，現提供從網上總結的Javadoc轉換chm幫助文件的四種方法，詳細提供各個轉換的步驟供大家學習，並且提供英文版本和中文版本Javadoc轉換過程中出現的問題，特別是中文的時候出現的亂碼現象，也提供一些解決方案。
預處理
轉換之前需要了解的是chm是微軟公司釋出的一種幫助文件格式，所有，要使用下面的方法轉換，請先安裝HTML Help Workshop（後面簡稱為HHW）（實際上後面的一些處理有些都是在上面操作的）
還有一個很重要的問題，就是如何把專案打成Javadoc，這有人應該會說，很簡單啊，就是使用Eclipse或者Myeclipse的Export功能，是的，這是可以，但是有些小的方面還是需要我們強烈注意的
第一個問題就是Java程式碼的格式問題
Java程式碼編寫的使用有的使用GBK，有的使用UTF-8，這個時候就會有區別。使用GBK編碼的時候生成Javadoc文件時沒有太大問題的，但是，要是整個專案的預設編碼格式是UTF-8的話，就會報警告：編碼 GBK 的不可對映字元
根本沒有成功生成Javadoc文件，如何解決？解決方案就是在生成Javadoc的時候對VM options
第二個問題就是如何把生成的Javadoc文件生成英語版本
這個問題有的時候為了解決中文亂碼是很重要的，我們生成英文版本的Javadoc（僅對生成的Javadoc框架的語言做限制，並沒有對註釋內容的格式做限制，也就是說這個時候註釋還是可以是中文的）。
解決方案也是在VM options中加入-locale en_US，但是此時注意的是，如果把-locale en_US設定在後面的話，會報一個錯誤，大致是-locale en_US 在javadoc命令必須是在最前面，所有，正確的寫法就是-locale en_US -encoding UTF-8 -charset UTF-8（整合上面），預設如果不寫-locale的話，安裝locale語言來進行設定，當然我們中國人就是中文的了。（當然如果你工程預設編碼是GBK而且您想生成中文的幫助文件的話，這寫都可以不要，使用預設即可）
設定截圖如下：
做好了上面的工作，現在就請大家看我是如何轉換成chm幫助文件的。
（做完這些，請生成中文和英文各一份Javadoc文件，供後面測試使用）
第一種：使用jd2chm來生成chm幫助文件
使用原版jd2chm_exe_03轉換成chm
原版jd2chm_exe_03需要通過官網下載不過現在我這是不可以訪問的，只能通過代理來訪問下載工具。（不要擔心，最後我會把所有的工具打包供大家下載）。下載解壓後就是一個jd2chm.exe檔案，怎麼使用？很簡單，就是把這個檔案放到需要生成Javadoc的目錄下，必須保證同一個目錄下一定要有index.html，不然不可生成，單擊，或者在cmd命令中開啟exe，填寫project name和title即可。
上面整個生成都很OK，中英文支援都非常的好，唯一遺憾的是，工具生成的時候加了About…和沒有順便生成.HHP, .HHK, .HHC檔案，有的時候About我們並不需要或者換成其他的，這個時候可以使用其他的chm編輯器或者HHW反編譯修改後重新編譯生成，具體操作請大家嘗試。
使用網上高手改進的版本jd2chm_0.34轉換成chm
請注意最後一個一定要選擇y，意思就是在原Javadoc文件裡修改一點東西（就我看，就是加了一個about.html），是否同意？不同意如何生成？
比原版本的好處是不需在放到Javadoc目錄下了，還可以使用最新的微軟雅黑字型，而且能夠生成hhc、hhk、hhp檔案，方便我們使用HHW進行編輯。遺憾還是about並且有點破壞了原Javadoc文件（加了一個about.html），這個時候通過HHW工具很方便的進行編輯（有了hhc、hhk、hhp檔案）。修改一份給大家看看，開啟hhp檔案，並開啟About…檔案，修改部分內容（就是一個html語言寫的網頁了）
修改完成後，儲存並編譯
對比下面修改後的About
第二種：使用javadoc2chm來生成chm幫助文件
先下載工具javadoc2chm-1.1.0.7.msi，搜尋下載（後面會提供），下載完成並安裝，會在開始選單裡生成程式快捷方式。
介面操作，很方便，英文支援非常好，中文有一處亂碼（上面目錄第一層），幾乎很完美，遺憾是Title後面加了-Generated by javadoc2chm和中文有點亂碼，沒有生成hhc、hhk、hhp檔案(實際上在轉換的時候是生成的這三個檔案，後面被刪除了，如果耍點小聰明的話，可以在生成過程中複製一份，如果速度快的話，會提示檔案已經被刪除，是否重試，這個時候再轉換，看檔案生成後點重試即可得到這三個檔案，不要反編譯多好)，這種方法建議使用英文版本。
自己修改了一份中文版本的轉換，現提供部分步驟
看看修改後的效果吧
第一次開啟的首頁
上面的兩種方法也是我極力推薦大家使用的，下面的兩種方法僅供學習，裡面有很多問題，中文亂碼什麼的，都會出現。
第三種：使用javadoc2help來生成chm幫助文件
官方網站，下載解壓即可，裡面最重要的就是lib目錄下面的Javadoc2Help.jar，注意我們就是使用這個jar檔案進行生成。官網上也提供瞭如何使用。
Cmd命令進入jar檔案目錄，寫下面的命令回車
java -jar Javadoc2Help.jar -chm -src f:/docs/api_en_US -dest f:/docs/api_en_US2
（具體路徑請根據需要修改）
注意：-dest後面的目錄請不要寫原目錄，不然生成不了chm並且覆蓋了原目錄檔案。
Cmd命令進入jar檔案目錄，寫下面的命令回車
java -jar Javadoc2Help.jar -chm -src f:/docs/api_zh_CN -dest f:/docs/api_zh_CN2
（具體路徑請根據需要修改）
注意：-dest後面的目錄請不要寫原目錄，不然生成不了chm並且覆蓋了原目錄檔案。
基本能夠完成轉換，但是不了建立索引，不能設定Title和檔名，對中文嚴重不支援不管是英文版本還是中文版本的chm都出現了中文亂碼現象，還有chm檔案就是便於查詢，竟然不能生產索引，建議不使用。
Google code上頁介紹瞭如何使用，解壓壓縮包。使用這個，就必須先安裝ruby和HHW。
Cmd命令進入javadoc2chm目錄，寫下面的命令
ruby createhhp.rb api_en_US f:/docs/api_en_US回車
"C:/Program Files/HTML Help Workshop/hhc.exe" api_en_US.hhp回車
（注意C:/Program Files/HTML Help Workshop/hhc.exe是HHW預設安裝路徑，如果不是請自行修改）
生成的chm檔案在解壓的包的資料夾裡：
開啟後是上面的這樣子，具體的原因不清楚，不過解決的方法就是把Javadoc資料夾和ruby命令的資料夾不要放在同一個盤內，不在同一個盤裡就會使用絕對路徑。重修生成，但是這種方法也並不適合，當我們把原Javadoc文件的資料夾刪除或者移動了，這個時候也會出現上面的情況。具體的我打開了hhp檔案查看了一下，應該是這種方法使用的是覺得路徑，而並沒有把檔案進行包裝在生成。（要檢視下面截圖的效果，請把docs資料夾保留）
命令
ruby createhhp.rb api_en_US e:/docs/api_en_US
"C:/Program Files/HTML Help Workshop/hhc.exe" api_en_US.hhp
Cmd命令進入javadoc2chm目錄，寫下面的命令
ruby createhhp.rb 中文幫助文件 e:/docs/api_zh_CN回車
"C:/Program Files/HTML Help Workshop/hhc.exe" 中文幫助文件.hhp回車
（注意C:/Program Files/HTML Help Workshop/hhc.exe是HHW預設安裝路徑，如果不是請自行修改）
不能設定Title和中文的Title時候亂碼，操作麻煩，還要安裝ruby輔助軟體。
總結
上面的一些不完美的地方，都可以使用HTML Help Workshop進行改善。實際上也是因為此次機遇，讓我學習了HTML Help Workshop的操作，以後製作chm文件就很方便了。
上面方法通過參考網上的操作總結自己親自實際而成，需要探討的請聯絡QQ：506817493。
順利提高所有工具和製作成果的檔案下載(不包括ruby輔助軟體，自行下載)
Javadoc轉換chm幫助文件的四種方法總結.rar
