如果您用过JDK API的chm文档,那么您一定不会拒绝接受其它第三方API的chm文档,比起普通的javadoc网页,chm更无疑更合适用作手册。
可是虽然将html转换成chm的软件多不胜举,却没有合适的软件可以将javadoc转换成像JDK API那种模式。JDK的chm文档可以层叠展开到类和方法,能相当漂亮提供这个功能的我只找到了JavadocToCHM。
JavadocToCHM的作者André Burgaud,
主目录:http://www.burgaud.com/jd2chm.html
下载地址:http://www.burgaud.com/download/jd2chm_exe_03.zip
下载后解压,会得到一个文件jd2chm.exe,这是一个没有界面的dos程序。
我的做法是将此文件扔到 C:/WINDOWS/system32 目录,
那样可以直接使用jd2chm命令操作(为了便于记忆,我将其改为jchm)。
如果你没有安装过Microsoft HTML Help Workshop,那你需要下载一个HTML Help Workshop安装。
好了,准备工作就这么多,下面是具体用法,很简单(如附图):
1)在CMD控制台中进入到需转换的javadoc的主目录,如X:/xx/commons-lang-2.1/docs/api/,注意,此目录必须包括index.html文件。
2)输入jd2chm(此处默认你已经已经将jd2chm.exe放到系统路径)。确定会提示你要输入项目名称和chm文件名称。输入确定完毕即可坐等收成。生成的文件跟index.html一个目录。