`
PerfectPlan
  • 浏览: 122947 次
  • 性别: Icon_minigender_1
  • 来自: 深圳
社区版块
存档分类
最新评论

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

阅读更多

 

Eclipse JavaDocjd2chm创建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  
楼主举个栗子啊。。

相关推荐

    图解JSP环境安装配置(CHM)

    同时,"codewww.com说明.txt"可能是提供额外帮助或注意事项的文档,而"启明星.url"则可能是一个链接,指向更多相关的学习资源。 通过以上步骤,你将能够搭建起一个完整的JSP开发环境,开始你的JSP编程之旅。记得在...

    《图解JSP环境安装配置(CHM) 》

    JavaServer Pages(JSP)是一种动态网页开发技术,由Sun Microsystems(现已被Oracle公司收购)推出,它允许开发者在HTML或XML文档中嵌入Java代码,实现服务器端的动态网页生成。JSP的安装配置是初学者必须掌握的...

    图解JSP环境安装配置.rar_jsp

    **图解JSP环境安装配置.chm** 文件很可能是一个帮助文档,详细解释了如何一步步配置JSP开发环境。CHM是Microsoft的 Compiled HTML Help 格式,通常用于技术文档,包含索引、搜索功能和组织良好的章节,方便用户查找...

    《MyEclipse 6 Java 开发中文教程》前10章

    3.2.22获取帮助和阅读帮助文档 65 3.2.23 CVS团队源代码管理(在线阅读) 66 3.2.24 修改文件的字符编码 66 3.3小结 66 第四章 用MyEclipse Database Explorer管理数据库 67 4.1功能一览 67 4.2使用MyEclipse ...

Global site tag (gtag.js) - Google Analytics