使用Eclipse生成CHM帮助文档(图解)

 

Eclipse JavaDoc和jd2chm创建CHM文档

由于图片在这里贴在这里比较麻烦，所以图片见附件

 

  一、首先创建一个java项目

  二、导入需要生成API文档的项目源文件

  三、复制到新建项目的src目录下

  四、导入项目所依赖的相应jar包

  要注意的是：处理view层的框架还需要用到 jsp.api.jar 和 servlet.api.jar

  这两个jar包可以在tomcat中的lib包中查找

 

  五、在Eclipse工具栏中的project->Generate javadoc 点击进去

    javadoc Generation(窗体名)

        选中java项目

      设置该窗体下的 user standard doclet 选择生成文件需要的路径

            之后点击Next

        之后可以填写文档的标题 Document title

     之后选中所有的jar包

     之后点击finish 完成操作

      转换之后在我们设置的文件夹中就会出现我们所需要的帮助文档，(全部都是html文件)

 

  六、使用jd2chm文件将html文件转换成chm文档

首先需要安装htmlhelp.exe程序

之后将jd2chm.exe文件放置到生成api对应的文件夹目录下

运行cmd定位到生成api对应的文件夹目录下

输入jd2chm回车

输入chm文件名

确认输入

之后回车，完成后会在文件夹中看见一个chm文档，制作就成功了

 

评论

2 楼 wangyudong 2017-11-27  

很多API doc生成工具生成doc需要重度依赖代码里加注解的方式，并且不支持自动化测试RESTful API。

之前习惯用一款名字为 WisdomTool REST Client，它能够基于测试过的历史记录自动生成精美的RESTful API文档，完全不用在代码里加注解，支持自动化测试RESTful API，输出精美的测试报告。
轻量级的工具，功能却很精悍哦！

https://github.com/wisdomtool/rest-client

Most of API doc tools do not support automated testing.

Once used a tool called WisdomTool REST Client supports automatically generating exquisite RESTful API documentation based on history testing cases without adding annotations to the code, it also supports automated testing, and outputs exquisite report.

Lightweight tool with very powerful features!

https://github.com/wisdomtool/rest-client

1 楼 time_siyecao 2016-05-03  

楼主举个栗子啊。。