如何生成api帮助文档chm文档

JavaScript022

如何生成api帮助文档chm文档,第1张

这里所用到的工具就是javadoc2chm.百度”javadoc2chm“下载。我看到有一个1积分下载的，我这里也有，需要的话可以私聊。

javadoc2chm.exe的大小只有102k左右，谨防上当受骗啊。

使用javadoc2chm制作帮助文档的时候，首先下载的文件中有帮助文档的html版。例如我下载的Struts2就有doc目录。

打开javadoc2chm.exe. path to javadoc是用来选择doc的路径的，output filename是用来给输出的chm一个名字，以.chm结尾，title是打开chm后首页的文字

我这里以制作Hadoop2.7.1的帮助文档实例。选好目录后，点击Go就开始只做了，制作完成后，go按键变黑色可用，只做好的chm文档存放在你选择的html帮助文档的目录里。

使用JDK_API文档的CHM版后，会自动生成一个CHW文件，这是因为chw和chq及chi文件是索引类文件，用于提高msdn查阅器的索引、关键字和全文搜索性能。两个文件必须放在一起才能使用索引。

chm（Compiled Help Manual），即“已编译的帮助文件”。CHM是微软新一代的帮助文件格式，利用HTML作源文，把帮助内容以类似数据库的形式编译储存。

所谓JDK1.6 只是SUN 公司推出的java 开发库，里面集成了很多常用的工具类及方法，也就是对应的具体的API，API（Application Programming Interface,应用程序编程接口）你只需要按照API定义的方法规范调用即可，不用管它内部是如何实现的。API中定义的方法有的需要参数有的不需要，有的有返回值，有的没有返回值，这些在如下API文档链接中都可以查询的到，关于你说的chm只是API文档的另一种表现形式，也是别人从官网API文档上加工成的.chm文档方便读者查阅的。

见官方文档链接：

http://www.oracle.com/technetwork/java/javase/documentation/api-jsp-136079.html