struts2 API chm帮助文档生成介绍说明(转)

简介:

原始地址:http://bbs.hx95.com/read-htm-tid-84450-uid-65.html

在struts2.2.3.1发布不久,网上很多人都在求struts2.2.3.1文档。
现在各式各样的API文档都已经出现了,但是制作教程大多是struts2.2.1.1版本的,虽然都是struts2 ,但是2个不同的版本做API文档还是有一点出入。
下面我们来制作struts2.2.3.1的API文档,struts2.2.1.1版本网上教程比较多,大家也可以利用搜索引擎去查找。
工具:
1   Myeclipse        
下载 http://xiexiejiao.cn/?r=http://downloads.myeclipseide.com/downloads/products/eworkbench/galileo/myeclipse-8.6.0-win32.exe
然后安装
2   struts2.2.3.1
下载  http://mirror.bjtu.edu.cn/apache//struts/binaries/struts-2.2.3.1-all.zip
然后解压
3   部分jar包   velocity-tools-2.0.jar
下载    http://dldx.csdn.net/fd.php?i=171535329482705&s=ba06c5970851a68b244e55939896fa7f
4 jd2chm
下载    http://www.burgaud.com/download/jd2chm_exe_03.zip
然后解压
因为struts2是开源的框架,而javaAPI文档的制作就是生成源代码里面的/*  */的东西
开始正文了
首先打开 Myeclipse
file—new—java project

4_65_b86670d376f3821.jpg
随意命名  这里命名为struts_hx了
上面我们解压了struts-2.2.3.1
找到 struts-2.2.3.1-all\struts-2.2.3.1\src\core\src\main\java这个目录 有个org的文件
复制org 文件到  struts_hx项目下的src目录

4_65_740c4d1f3b21747.jpg
我们看到全是红色的错误信息,因为我们没有把struts2里面的jar包导入
在当前项目点击鼠标右键build path—configure build path

4_65_4ae1603f98d05a5.jpg
点击右边第二项  然后找到struts-2.2.3.1-all\struts-2.2.3.1\lib目录
lib目录为struts2的所有jar包
全选  打开

4_65_2536e4adff02331.jpg
然后点击OK。
我们看到现在还是有错误信息,查看下相关错误信息

4_65_f717f08dd0216c9.jpg
可以看出是支持servlet   API jar包没有被导入
按照之前的方法导入jsp-api.jar和servlet-api.jar
这两个jar包都可以在tomcat\lib目录下找到,如果没有安装tomcat可以在百度搜索这2个jar包下面然后导入
在当前项目点击鼠标右键build path—configure build path
点击右边第二项找到jsp-api.jar和servlet-api.jar所在目录

4_65_9c252331ced281a.jpg
点击打开   OK
但是还是不行  还是有错误,查看错误信息

4_65_4599d032f23ab1c.jpg
可以看出缺少velocity-tools  jar包
前面我们已经下载了,现在按照前面的方法
在当前项目点击鼠标右键build path—configure build path
点击右边第二项找到velocity-tools-2.0.jar包所在目录

4_65_702df19ca2d05ab.jpg
点击打开   OK 。
现在没有错误信息了  ,然后我们就可以开始制作API文档了
如图

4_65_526358a991afc42.jpg
选择struts_hx项目文件,next
然后如图

4_65_2adf122336f4660.jpg
点击next,点击finish,点击yes to all
开始生成

4_65_ea7cb2157abc241.jpg
这里的是警告信息,不影响我们的制作。
现在我们的API基本就完成了。
打开你的项目存放文件 myworkspace\struts_hx\doc

4_65_09249b543f234b8.jpg
双击 index.html

4_65_2203d706127ba36.jpg
html格式的API文档就制作好了,下面我们转化为chm格式
到了这里就要使用我们下载的第四个工具   jd2chm
复制解压后的jd2chm.exe文件到myworkspace\struts_hx\doc目录下
点击 开始 运行 cdm 确定
使用 cd命名 切换到 myworkspace\struts_hx\doc目录

4_65_31229e358dab909.jpg
到了这里我们的制作就完成了
打开看看吧

4_65_8d45a84a309f142.jpg
其实制作还是比较简单,在网上搜索没有发现相关教程,所以在此详细图解!



本文转自hcy's workbench博客园博客,原文链接:http://www.cnblogs.com/alterhu/archive/2012/03/23/2413659.html,如需转载请自行联系原作者。


目录
相关文章
|
算法 IDE Java
【CPLEX教程02】配置Cplex的Java环境以及API说明
【CPLEX教程02】配置Cplex的Java环境以及API说明
740 0
【CPLEX教程02】配置Cplex的Java环境以及API说明
|
API
java202302java学习笔记第十四天-api和api帮助文档1
java202302java学习笔记第十四天-api和api帮助文档1
75 0
java202302java学习笔记第十四天-api和api帮助文档1
|
API
java202302java学习笔记第十四天-api和api帮助文档2
java202302java学习笔记第十四天-api和api帮助文档2
73 0
java202302java学习笔记第十四天-api和api帮助文档2
|
前端开发 Java 测试技术
8.Spring Boot2.5 实战 API 帮助文档 Swagger1|学习笔记
快速学习8.Spring Boot2.5 实战 API 帮助文档 Swagger1。
200 0
8.Spring Boot2.5 实战 API 帮助文档 Swagger1|学习笔记
|
域名解析 JSON API
HTTPDNS 的 API 的说明|学习笔记
快速学习 HTTPDNS 的 API 的说明
221 0
HTTPDNS 的 API 的说明|学习笔记
|
Java API
java学习第九天笔记-方法174-api和api帮助文档1
java学习第九天笔记-方法174-api和api帮助文档1
76 0
java学习第九天笔记-方法174-api和api帮助文档1
|
Java API
java学习第九天笔记-方法173-api和api帮助文档
java学习第九天笔记-方法173-api和api帮助文档
82 0
java学习第九天笔记-方法173-api和api帮助文档
|
API Android开发
【错误记录】Google Play 上架报错 ( APK 大小 | 目标 API 级别 | Google Play 帮助文档 )
【错误记录】Google Play 上架报错 ( APK 大小 | 目标 API 级别 | Google Play 帮助文档 )
384 0
【错误记录】Google Play 上架报错 ( APK 大小 | 目标 API 级别 | Google Play 帮助文档 )
|
API 语音技术
API接口调用里的QPS指什么?百度语音API里的QPS实例说明
API接口调用里的QPS指什么?百度语音API里的QPS实例说明
529 0
API接口调用里的QPS指什么?百度语音API里的QPS实例说明