javadoc转换chm帮助文档的四种方法总结

《javadoc转换chm帮助文档的四种方法总结》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Javadoc转换chm帮助文档的四种方法总结V1.0目录关键词1前言1预处理1第一种：使用jd2chm来生成chm帮助文档4使用原版jd2chm_exe_03转换成chm4生成英文版本如下4生成中文版本如下5使用网上高手改进的版本jd2chm_0.34转换成chm7生成英文版本如下7生成中文版本如下8第二种：使用javadoc2chm来生成chm帮助文档11生成英文版本如下11生成中文版本如下12第三种：使用javadoc2help来生成chm帮助文档18生成英文版本如下18生成中文版本如下18第

2、四种：使用googlecode里面的javadoc2chm项目构建20生成英文版本如下20生成中文版本如下22总结23  李顺利 [2010年1月6日]   关键词Javadocchm转换jd2chmjavadoc2chmjavadoc2helpJavadoc2chm中文乱码李顺利 前言朋友，当您在一个项目完成后，是不是需要把你的源码打包并且把注释打成Javadoc交给客户，Eclipse或者MyEclipse自动打成的Javadoc文档都是基于网页格式的，打开是很方便，不过真的用的时候，搜索每个方

3、法或者什么的就很麻烦了，而chm帮助文档格式不但文件小，查阅都很方便，所以网上就出现了很多把Javadoc转换为chm格式的帮助文档的软件/工具或者方法。自己最近需要真的需要这个方面的需求，查阅了网上很多方法，发现很多都是写的很不详细，对于我这种刚接触的很是不清楚，经过我的学习和理解，现提供从网上总结的Javadoc转换chm帮助文档的四种方法，详细提供各个转换的步骤供大家学习，并且提供英文版本和中文版本Javadoc转换过程中出现的问题，特别是中文的时候出现的乱码现象，也提供一些解决方案。预处理转

4、换之前需要了解的是chm是微软公司发布的一种帮助文档格式，所有，要使用下面的方法转换，请先安装HTMLHelpWorkshop（后面简称为HHW）（实际上后面的一些处理有些都是在上面操作的） http://msdn.microsoft.com/en-us/library/ms669985.aspx，下载完毕后就是安装了，很简单。还有一个很重要的问题，就是如何把项目打成Javadoc，这有人应该会说，很简单啊，就是使用Eclipse或者Myeclipse的Export功能，是的，这是可以，但是有些小的

5、方面还是需要我们强烈注意的第一个问题就是Java代码的格式问题Java代码编写的使用有的使用GBK，有的使用UTF-8，这个时候就会有区别。使用GBK编码的时候生成Javadoc文档时没有太大问题的，但是，要是整个项目的默认编码格式是UTF-8的话，就会报警告：编码GBK的不可映射字符根本没有成功生成Javadoc文档，如何解决？解决方案就是在生成Javadoc的时候对VMoptions进行编码设置-encodingUTF-8-charsetUTF-8，设置如下： 第二个问题就是如何把生成的Java

6、doc文档生成英语版本这个问题有的时候为了解决中文乱码是很重要的，我们生成英文版本的Javadoc（仅对生成的Javadoc框架的语言做限制，并没有对注释内容的格式做限制，也就是说这个时候注释还是可以是中文的）。解决方案也是在VMoptions中加入-localeen_US，但是此时注意的是，如果把-localeen_US设置在后面的话，会报一个错误，大致是-localeen_US在javadoc命令必须是在最前面，所有，正确的写法就是-localeen_US-encodingUTF-8-chars

7、etUTF-8（整合上面），默认如果不写-locale的话，安装locale语言来进行设置，当然我们中国人就是中文的了。（当然如果你工程默认编码是GBK而且您想生成中文的帮助文档的话，这写都可以不要，使用默认即可）设置截图如下：做好了上面的工作，现在就请大家看我是如何转换成chm帮助文档的。（做完这些，请生成中文和英文各一份Javadoc文档，供后面测试使用） 第一种：使用jd2chm来生成chm帮助文档使用原版jd2chm_exe_03转换成chm原版jd2chm_exe_03需要通过官网下载ht

8、tp://www.burgaud.com/jd2chm.html不过现在我这是不可以访问的，只能通过代理来访问下载工具。（不要担心，最后我会把所有的工具打包供大家下载）。下载解压后就是一个jd2chm.exe文件，怎么使用？很简单，就是把这个文件放到需要生成Javadoc的目录下，必须保证同一个目录下一定要有index.html，不然不可生成，单击，或者在cmd命令中打开exe，填写projectname和title即可。生成英文版本如下生成中文版本如下 上面整个生成