Javadoc转换chm帮助文档的四种方式总结
V1.0
javadoc chm转换 jd2chm javadoc2chm javadoc2help Javadoc2chm 中文乱码 李顺利
前言
小伙伴们，当你完成一个项目后，是否需要将你的源代码打包并打出注释成Javadoc供客户使用呢？ Eclipse或MyEclipse手动打出的Javadoc文档是基于Web格式的，打开起来非常方便。 但是真正使用的时候，要各个方法什么的都要搜索，非常麻烦，而且chm帮助文档格式不仅体积小，而且查找起来也很方便，所以网上有很多帮助文档将 Javadoc 转换为 chm 格式的软件/工具或技术。
最近，我真的很需要这个需求。 我在网上查了很多方法，发现很多都写得不详细。 我对那些新来的人很不清楚。 经过我的学习和理解，现在提供一下网上的总结。 Javadoc以四种方式转换chm帮助文档，提供了每种转换的详细步骤供您学习，并提供了中文版和英文版的Javadoc转换过程，特别是英文出现乱码的现象，还提供了一些解决方案。
预处理
转换之前需要了解的是，chm是微软公司发布的一种帮助文档格式。 因此，如果您想使用下面的方法进行转换，请安装HTML Help Workshop（以下简称HHW）（实际上，前面的一些处理是在之前操作的）
，下载完成后就安装了，很简单。
还有一个很重要的问题，就是如何将项目打入Javadoc。 有人应该说很简单，用Eclipse或者Myeclipse的Export功能就可以了。 是的，这是可能的，但是一些小方面仍然需要我们强烈注意
第一个问题是Java代码的格式
有的使用GBK进行Java代码编译，有的使用UTF-8，这时候就会有区别。使用GBK编码生成Javadoc文档没有太大问题。 但如果整个项目的默认编码格式是UTF-8，则会报警告：Unmappable characters encoded in GBK
Javadoc文档根本没有成功生成，如何解决？ 解决办法是在生成Javadoc时设置VM options的编码 -encoding UTF-8 -charset UTF-8，如下：
第二个问题是如何将生成的Javadoc文档生成英文版本
有时为了解决英文乱码这个问题非常重要。 我们生成中文版的Javadoc（只是生成的Javadoc框架的语言受到限制，注释内容的格式没有限制，也就是说，此时的注释可能仍然是英文）。
解决办法是在VM选项中添加-locale en_US，但是请注意，如果-locale en_US设置在前面的话，会报错，大致就是-locale en_US必须在javadoc命令的前面，所有，正确的写法是 -locale en_US -encoding UTF-8 -charset UTF-8 (integrated)。 如果默认不写-locale，请安装区域设置语言来设置。 当然，我们中国人是英国人。 （当然，如果你的项目默认编码是GBK，并且要生成英文帮助文档，则不需要写这个，使用默认即可）
设置截图如下：
完成了前面的工作，现在请看我如何将其转换为chm帮助文档。
（完成此操作后，请生成英文和法文的Javadoc文档，以供之前的测试使用）
第一种方法：使用jd2chm生成chm帮助文档，使用原来的jd2chm_exe_03转换为chm
原来的jd2chm_exe_03需要通过官网下载html帮助文档，但是现在无法访问，只能通过代理访问下载工具。 （不用担心，最后我会把所有工具打包给大家下载）。 下载解压后是一个jd2chm.exe文件，如何使用呢？ 很简单，只要把这个文件放在需要生成Javadoc的目录下即可。 必须保证同目录下必须有index.html，否则无法生成。 点击，或者在cmd命令中打开exe，填写项目名称和标题。 能。
生成英文版本如下
生成英文版如下
上面整代都还可以，中英文支持都很好。 唯一遗憾的是工具生成时添加了About...，没有顺便生成.HHP、.HHK、.HHC文件。 有时我们没有使用About No need或者用其他的替换它。 这时可以使用其他chm编辑器或者HHW反编译重新编译生成。 具体操作请尝试一下。
使用在线高手的改进版本jd2chm_0.34转换为chm
网上一位大神改了很多有用的地方，想了解的请移步查看下载。
生成英文版本如下
请注意，最后一项必须选择y，这意味着要更改原始Javadoc文档中的某些内容（在我看来，只需添加一个about.html），您同意吗？ 不同意如何生成？
生成英文版如下
相比原版的优点是不需要放在Javadoc目录下，而且还可以使用最新的微软雅黑字体，还可以生成hhc、hhk、hhp文件，方便我们使用 HHW 进行编辑。 可惜about还是about，有点破坏了原来的Javadoc文档（加了一个about.html）。 这时候通过HHW工具（带有hhc、hhk、hhp文件）进行编辑就非常方便了。 修改一份给你看，打开hhp文件html帮助文档，然后打开About...文件，修改一些内容（是html语言写的网页）
修改后保存并编译
比较下面修改后的关于
第二种：使用javadoc2chm生成chm帮助文档
首先下载工具javadoc2chm-1.1.0.7.msi，搜索下载（后面会提供），下载完成并安装后，会在开始菜单中生成一个程序快捷方式。
生成英文版本如下
生成英文版如下
界面操作非常方便，并且英文支持非常好。 中文有乱码（上面目录第一层），已经近乎完美了。 可惜Title前面加了-Generate by javadoc2chm，英文有点乱码，没有生成hhc、hhk、hhp文件。 （其实这三个文件是在转换的时候生成的，后来就被删除了，如果你聪明的话，可以在生成过程中复制一份，如果速度快的话，会提示你文件已经被删除了）删除。尝试一下，这时候再转换一下，生成文件后点击重试即可得到这三个文件，不要反编译），建议使用英文版的这种方式。
我自己更改了英文版本的转换，现在提供一些步骤
我们看看修改后的效果
发表评论