Struts2 API的chm格式帮助文档制作教程

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格式的。启动工具如下所示：

12、按照上图的设置，点击“Go”按钮，就可以生成chm格式的文件了，生成chm文件可能需要htmlhelp的支持。使用1.7的javadoc生成chm如下所示：

使用1.6的javadoc生成的chm格式文档如下所示：

    最后献上Struts2.3.4的API文档地址，包含了所依赖的最简包：

http://download.csdn.net/detail/long2010yu2010/5787657