使用eclipse生成javadoc帮助文档

时间:2021-02-10 09:34:23

方式一:

1.首先,打开Eclipse,在需要生成Javadoc的项目上右击鼠标,在弹出来的列表中点击”Export“选项。

使用eclipse生成javadoc帮助文档


2.在弹出来的”Export“窗口中,选择导出的目标,这里选择Java文件夹下的Javadoc,然后点击”Next“按钮。

使用eclipse生成javadoc帮助文档

3.进入到”选择生成Javadoc的类型“界面,这里默认已经配置好了生成Javdoc的javadoc.exe的路径,如果不对可以重新配置。在Create Javadoc for members...一栏选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容。在“Use standard doclet”一栏中选择输出Javadoc的目录,默认是在工作空间工程项目下的doc文件夹中,也可以自行配置,然后点击”Next“按钮。

使用eclipse生成javadoc帮助文档

4.进入到”配置Use standard doclet的Javadoc变量“界面,可以根据需要配置Javadoc的变量,可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类,并且将该库链接到它的javadoc,可以在“Select referenced...”列表中选择,然后点击“Next”按钮。

使用eclipse生成javadoc帮助文档

5.进入到“配置Javadoc变量”界面,这里注意:如果项目采用的是UTF-8编码,Extra Javadoc options(额外的Javadoc选项)下需要输入设定参数:-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码,点击“Finish”按钮。

使用eclipse生成javadoc帮助文档

6.在点击“Finish”按钮后,会看到Eclipse主界面的“控制台”输出Javdoc生成成功的信息。

使用eclipse生成javadoc帮助文档

7.查看生成的Javadoc帮助文档。进入到工作空间对应的工程项目下,可以看到有个doc文件夹(当然这是默认的输出目录,如果你在生成Javadoc时设置了其它目录,可以进入相应的目录中)。

使用eclipse生成javadoc帮助文档

8.点击doc文件夹,会发现doc文件夹中有好多.html文件,打开index.html文件。

使用eclipse生成javadoc帮助文档

9.可以看到生成的API文档,这里面显示了相应信息。

使用eclipse生成javadoc帮助文档

10.点击其中的类,可以看到相应类的信息,如你设置的版本、作者,还可以看到继承的类等信息,有助于快速了解源代码。

使用eclipse生成javadoc帮助文档


方式二:

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

使用eclipse生成javadoc帮助文档

其余步骤同方式一。