为项目生成html/chm格式API

淩亂°似流年 2022-08-08 06:18 157阅读 0赞

准备工作:

Javadoc to chm官网: [ http://jan.baresovi.cz/dr/en/javadoc-chm][http_jan.baresovi.cz_dr_en_javadoc-chm]  -> 下载javadoc2chm.1.3.1.11.msi

HTML Help Workshop: [ http://www.microsoft.com/en-us/download/details.aspx?id=21138][http_www.microsoft.com_en-us_download_details.aspx_id_21138] -> 下载htmlhelp.exe

**一. 将项目导出成html格式API文档**

1. 选中项目 -> 菜单栏Project -> Generate Javadoc...

2. 选择visibility, 默认是Public, 可以选择Private; 点击Browse...选择输出路径 -> Next

3. 为API文档起个名字, 例如: Project Doc; 为了保证生成的api过程中没有错误, 点击Select All选择所有的引用jar包(**注意:**如果有些jar包不在列表中, 如servlet-api.jar, 可以将这个jar包复制到项目的lib目录下, 等生成完api文档后, 再从项目的lib目录下删除掉) -> Next

![Center][]

4. 为保证生成过程中, 编码不统一导致错误, 这里加上一行参数: \-encoding utf-8 -charset utf-8

![Center 1][]

5. Finish -> Yes To All; 如果控制台有错误, 将错误解决掉, 警告可以忽略掉, 之后就可以到指定的路径下查看生成的api文档了

**二. 将html格式API转为chm格式**

1. 安装之前下载的javadoc2chm.1.3.1.11.msi 及 htmlhelp.exe

2. 安装完成后, 在开始 -> 所有程序 -> javadoc2chm -> 点击打开”javadoc2chm”

3. 点击Browse…选择index.html文件, 填写输出文件名称, 以及生成的chm文件的title

![Center 2][]

4. 点击Go按钮, 开始生成chm文件, 完成后, 进入Progress会显示Finished

![Center 3][]

5. 查看生成的文档

[http_jan.baresovi.cz_dr_en_javadoc-chm]: http://jan.baresovi.cz/dr/en/javadoc-chm
[http_www.microsoft.com_en-us_download_details.aspx_id_21138]: http://www.microsoft.com/en-us/download/details.aspx?id=21138
[Center]: /images/20220805/9f89ba22c86f4e90bfc995b6f1abc776.png
[Center 1]: /images/20220805/46049e0fc800405d8c2f703a0279b0b4.png
[Center 2]: /images/20220805/11e455f7a34a42519b7ae1347e618a7b.png
[Center 3]: /images/20220805/7853b840a79148398aaaa3021843deb3.png