eclipse中javadoc给项目生成api文档

时间:2023-12-29 13:43:44

步骤

1.打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/

eclipse中javadoc给项目生成api文档

2.javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。

eclipse中javadoc给项目生成api文档

3.点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。

eclipse中javadoc给项目生成api文档

4.(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(5)点击【Next】按钮

eclipse中javadoc给项目生成api文档

5.(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮

eclipse中javadoc给项目生成api文档

6.

(1)选择使用的jdk版本

(2)点击【Finish】按钮

eclipse中javadoc给项目生成api文档

7.

可以看到控制台输出生成javadoc的信息。

eclipse中javadoc给项目生成api文档

8.

项目下生成一个【doc】的目录,里面存放着javadoc文档。

eclipse中javadoc给项目生成api文档

9.

打开doc目录,用浏览器打开index.html

eclipse中javadoc给项目生成api文档

注意点

有的时候生成的文档是中文乱码的,这个时候在第六步的时候需要加上-encoding UTF-8 -charset UTF-8

eclipse中javadoc给项目生成api文档