如何生成JavaAPI doc

1         准备工作

1.1    填写完整的注释

对需要生成API的类,填写完整的注释,包括类注释,方法注释,具体格式如下:

类注释:

原先可能author是作者,需要修改成author英文的,

另外去掉

方法注释:

 

每一个方法的参数注释都要有意义,没有参数的就不需要参数注释

1.2    新建一个临时目录

在你的电脑的任意位置新建一个文件夹,比如是JavaDoc,用来放置导出的javadoc文件,我这边新建的是D:JavaDoc

1.3    准备API生成工具

,解压到任意目录即可,我这边解压到如下位置: C:jd2chm_0.34

至此,准备工作完毕,可以开始生成了

2         生成JavaDoc文档

2.1    选择你需要生成API的类,或者是包,右键选择Export,选择Javadoc

 

2.2    点击next,选择目标文件夹为之前创建的JavaDoc

 

2.3    点击next,上面的checkbox全部打上勾

 

2.4    点击next,参数里面添加编码: -encoding UTF-8 -charset UTF-8,因为我们一般都是采用UTF-8编码,不设置的话导出会出现问题

 

2.5    点击finish,查看控制台的打印信息,看是否有报错和警告,有的话可以看提示相应解决

 

3         生成API文档

1 

3.1    首先查看我们的JavaDoc是否成功导出

 

3.2    开始，Cmd进入命令窗口

 

3.3    切换到我们刚才解压的工具目录

输入cd C:jd2chm_0.34，按回车

 

3.4    运行工具程序

输入：jd2chm.exe，按回车，出现如下界面

 

3.5    输入JavaDoc目录

输入F:docAPI，按回车

 

3.6    输入API文档名字

输入组织架构API，按回车

 

3.7    其他配置如下

 

最后一个选择y后按回车，就开始生成API了

成功生成结果如图：

 

4         一些其他小修饰

4.1    阅读chm文档

双击chm文档，我们可以看到如下内容：

 

每个方法的详细说明都可以看见

 

4.2    去除说明

但是目录里面的最上面有一个如下的说明：

 

解压安装如下工具：

 

安装完毕后双击快捷方式打开：

 

文件，打开D:JavaDoc组织架构API.hhp文件

切换到目录，把about删掉

 

点击编译按钮(眼镜左边的)：

完成后我们再打开chm文档：不再有about了，当然你也可以修改about的信息

5         FAQ

E:项目FrameTenantTable.java:1: 非法字符： 65279

可以将java文件copy出来，用文档编辑器打开后另存utf-8格式，再copy回来即可

jd2chm_0.34、HA_HHWorkShop474_ljh  这2个工具包可以网上自行下载