Struts2 API的chm格式幫助文檔製作教程

在SSH三個框架中，Struts2的API文檔是最難做的，這裏所說的格式是chm格式的，chm的格式很方便，Hibernate API文檔和Spring API文檔只要通過相應的工具，和對應的javadoc就可以製作了，但是Struts2這個框架是兩個框架結合的產物，所以官方將這兩個框架單獨的做成了API文檔，如果要做需要分成兩個API文檔了。不利於我們的管理和查找。在開始學習Strust2的時候，就跟着視頻學做API了，但是沒有成功，昨天學Struts2的時候想再試一下，沒想到成功了。將兩個框架的API合到一起了，所以現在將我的心得和過程分享給大家。

準備材料：

Javadoc2chm，下載地址：http://jan.baresovi.cz/dr/en/en/download

Struts2的源代碼，下載地址：http://struts.apache.org/

製作的過程大概是這樣的：首先根據Struts2的源代碼，通過命令或者是工具生成Javadoc，然後通過工具生成對應的chm格式的API文檔。

1、首先找到Struts2 core和xwork的源代碼，源代碼所在的地址是：

Struts2的主目錄\src\core\src\main\java和Struts2的主目錄\src\xwork-core\src\main\java,如圖所示：

2、然後在MyEclipse中新建一個web項目Make_Struts2_API，將上圖中的org文件夾和com文件夾，放入到src下面，項目的結構如圖所示：

3、項目的源代碼導入完成之後，由於缺少相應的jar包，會出現叉號，以前我就是有很多的叉，來生成的，結果沒有成功。這回我終於將所有的叉整沒了，導出就成功了。這個項目所依賴的最簡包如下所示：

4、將項目所需要的jar包放入lib文件夾，這裏有servlet和jsp的api的jar包，在tomcat的lib文件夾下可以找到，還有幾個spring的jar包，可以從spring裏得到，還有些jar包可以從struts2的jar包裏得到。導入完成之後，就沒有紅色的叉了。

5、然後在項目上鼠標右鍵選擇“Export”命令，如圖所示：

6、選擇javadoc，單擊next按鈕繼續，如圖所示：

7、接下來選擇javadoc命令所在的位置及生成的doc文檔的存儲的位置默認是項目下的，這裏我所使用的是jdk1.7的javadoc，1.7的javadoc和1.6的javadoc生成的文檔樣式是不一樣的，單擊next按鈕，如圖所示：

8、接下來可以設置API文檔的標題，也可以指定第三方類庫的javadoc的位置，這樣查詢第三方類的時候，就可以看到說明，這裏就不設置瞭如圖所示：

9、接下來是最重要的一個步驟，要設置javadoc的編碼，如果不設置，在用瀏覽器瀏覽的時候可能會出現亂碼，這裏設置UTF-8的編碼，如圖所示：

10、單擊“Finish”按鈕，開始導出doc文檔，等一會導出就完成了。有警告沒什麼事。如圖所示：

11、有些人可能知道jd2chm這個工具，這個工具可以將html格式的struts2 API編譯成chm格式的，但是這個工具只支持jdk1.6生成的文檔，不支持1.7的javadoc文檔。所以這裏不用了，這也是我今天發現的。所以這裏選擇javadoc2chm這個工具，可以將1.7的文檔編譯成chm格式的。啓動工具如下所示：