如何使用eclipse生成javadoc帮助文档

Posted 2023-02-27

首先，打开Eclipse，在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”导出(O)...“选项。

在弹出来的”导出“窗口中，选择导出的目标，这里选择Java文件夹下的Javadoc，然后点击”下一步（N）“按钮。

进入到”选择生成Javadoc的类型“界面，这里默认已经配置好了生成Javdoc的javadoc.exe的路径，如果不对可以重新配置，在“使用标准Doclet(S)”一栏中选择输入Javadoc的目录，默认实在工作空间工程项目下的doc文件夹中，也可以自行配置，然后点击”下一步（N）“按钮。

进入到”配置标准doclet的Javadoc自变量“界面，可以根据需要配置Javadoc的自变量，可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类，并且将该库链接到它的javadoc，可以在“选择应将链接生成至的被引用归档和项目（R）”列表中选择，然后点击“下一步（N）”按钮。

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

在点击“完成”按钮后，会看到Eclipse主界面的“控制台”输入Javdoc生成成功的信息。

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

点击进度doc文件夹，会发现doc文件夹中有好多.html文件，打开index.html文件。

可以看到生成的API文档，这里面显示了过程中的相应信息。

点击其中的类，可以看到相应类的信息，如你设置的版本、作者，还可以看到继承的类等信息，有助于快速了解源代码。 参考技术A 使用eclipse生成文档（javadoc）主要有三种方法：
1，在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。
在Javadoc Generation对话框中有两个地方要注意的：
javadoc command:应该选择jdk的bin/javadoc.exe
destination:为生成文档的保存路径，可自由选择。
按finish(完成)提交即可开始生成文档。
2，用菜单选择：File->Export(文件－>导出)，
剩下的步骤和第一种方法是一样的。
3，选中要生成文档的项目，然后用菜单选择，
Project->Generate Javadoc直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。本回答被提问者采纳 参考技术B javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。