java 使用Eclipse生成Javadoc文件

java 使用Eclipse生成Javadoc文件

在Java中，Javadoc是从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

在前面的章节中，我们已经介绍过通过【命令提示符】窗口中的Javadoc命令来生成API帮助文档。下面我们来介绍一下，在Eclipse中如何生成API帮助文档。

操作步骤：

（1）在【包资源管理器】视图中，选择需要生成Javadoc文档的项目，并执行【项目】|【生成Javadoc】命令，如图2-7所示。

图2-7 执行【生成Javadoc】命令

（2）在弹出的【Javadoc生成】向导中，将显示执行javadoc.exe文件的路径，并显示所选择的项目目录，单击【下一步】按钮，如图2-8所示。

图2-8 设置生成Javadoc各参数

（3）在弹出的对话框中，输入【文档标题】为“文档帮助”，并设置生成文档各参数内容，单击【完成】按钮，如图2-9所示。

图2-9 设置生成API各参数内容

（4）在弹出的【更新Javadoc位置】对话框中，单击【全部为是】按钮，如图2-10所示。

图2-10 设置文档所保存的位置

（5）完成后，可以保存文档的位置查看所生成的文档内容，如打开“F:\sc\doc”文件夹，并查看所生成Html格式的文档，如图2-11所示。

图2-11 查看所生成的文件

（6）在该文件夹中，双击index.html文件，并通过IE浏览器打开javadoc文件，

如图2-12所示。在IE浏览器中，将显示该项目中所使用的类、方法、成员等内容。

图2-12 显示所抽取项目类、方法等内容