Struts2学习笔记---Struts2.2.1.1生成chm格式帮助文档

小知识：

Struts中有三个.xml文件

struts-default.xml--默认的配置文件，在jar包里能找到

struts-plugin.xml--插件的配置文件

struts.xml--我们自己写的配置文件

由于Struts2.2不在提供API帮助文档，所以为开发人员造成了一些不便，不过由于struts2.2.1.1是开源项目，我们可以用javadoc命令就可以将其编译成doc文档，然后再通过doc文档转换成chm文档

第一步：

找到E:\JavaJars\struts-2.2.1.1\src\core\src\main\java目录，会看到里面有个org目录，拷贝整个目录，并且新建一个JAVA项目，名字为API，然后将刚才拷贝的org目录粘贴到src目录下，这个时候会看到很多的错误，这个正常，因为这些源代码有很多依赖，所以加入这些依赖就可以了

第二步：

找到E:\JavaJars\struts-2.2.1.1\lib目录，里面有很多的jar文件，我们只需要将struts2-core-2.2.1.1.jar排除即可，其他的都选中，然后点击API项目右键---Build Path---Add External Archives...---选中除struts2-core-2.2.1.1.jar以外的所有的jar文件

第三步：

此时，可能还会有错误。在VelocityManager.java文件里的HttpServletRequest找不到，很正常，因为我们创建的是普通的JAVA项目，而不是JAVA WEB项目，我们可以将tomcat的lib目录下的servlet-api.jar和jsp-api.jar文件再引入到API项目中，这样所有项目就都没有了

第四步：

选中API项目，点击菜单栏的Project---Generate JavaDoc...，会弹出如下的界面

 将Destination选择到桌面上新创建的一个名为Struts-api2.2.1.1的文件夹下。

点击Next

 finish就可以了，如果点击Next，会提示是否update，也可以点击 yes to all。

第五步：

你会看到在myeclipse的控制台里有导出的信息，可能会有一些警告，但是对于生成文档没有影响

结束后，你会看到Sturts-api2.2.1.1目录下生成了很多文档，点击index.html、

 

第六步：

我们想要的不是html版的，相比chm格式的要更爽一些，所以现在开始转换为chm格式的文档

首先需要jd2chm.exe这个转换软件，可以到网上搜索，也可以到

JavadocToCHM的作者André Burgaud，

主目录：http://www.burgaud.com/jd2chm.html

下载地址：http://www.burgaud.com/download/jd2chm_exe_03.zip

上下载。

另外，要注意的是，在转换之前，需要下载一个名为Microsoft HTML Help workshop的软件，这个软件也可以在网上搜到，安装玩这个软件之后，才能够使用jd2chm.exe工具

第七步：

将jd2chm.exe放到Sturts-api2.2.1.1目录下

然后进行如下操作

 

然后你就会在Sturts-api2.2.1.1目录下看到那个chm格式的帮助文档了，大功告成