如何在Eclipse中生成Javadoc HTML文件？

Question

我在我的项目代码中编写了像这样的Javadoc风格的注释：

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

我该如何使用Eclipse IDE生成Javadoc HTML文件？

- JaneNY

---

请参考以下链接：https://learnjava-soa.blogspot.com/2015/06/how-to-generate-java-document-in-eclipse.html，了解如何在Eclipse中生成Java文档。 - madhu

Answer 1

1. 点击 项目 > 生成 Javadoc...。

2. 在 Javadoc 命令: 栏中，浏览以找到 javadoc.exe （通常位于 [path_to_jdk_directory]\bin\javadoc.exe）。

3. 选中要创建 Javadoc 的项目/包/文件旁边的复选框。

4. 在 目标: 栏中，浏览以找到所需的目标位置（例如，当前项目的根目录）。

5. 单击 完成。

现在您应该能够在目标文件夹中找到新生成的 Javadoc。 打开 index.html。

- Renu P

---

Java JDK需要安装吗？我已经安装了Java并且可以在Eclipse中创建Java程序...但是javadoc.exe在我的硬盘上不存在！ - AlainD

对于未来可能会混淆的任何人，请注意检查您是否安装了JDK，而非JRE（该位置不包含javadoc.exe）的旧版本。 - omoshiroiii

Answer 2

这是一份与OP相关的补充回答：

在Eclipse中添加Javadocs注释的简单可靠解决方案：

1. 前往 帮助 > Eclipse市场...。
2. 找到 "JAutodoc"。
3. 安装并重新启动Eclipse。

要使用此工具，请右键单击类并单击 JAutodoc。

- pioneerBhawna

---

据我所知，JAutodoc不能从现有的javadoc注释中生成HTML（这是问题所要求的），而是帮助生成javadoc注释。 - Amani Kilumanga

Eclipse可以让您生成Javadocs文档：项目 -> 生成Javadocs... - Gsv

这只会生成javadoc，而不是问题所涉及的HTML。 - Ashish

Answer 3

您也可以更加便捷地通过命令行完成此操作。

1. 从您的文件夹/包打开命令行。

2. 在命令行中运行：

   javadoc YourClassName.java

3. 批量生成多个类的文档：

   javadoc *.java

- Sean Das

Answer 4

快速添加Javadoc的方法如下快捷键：

Windows：Alt + Shift + J

Mac：⌘ + Alt + J

根据所选上下文，将打印出相应的Javadoc。要创建由OP编写的Javadoc，请选择相应的方法并按快捷键。请注意保留HTML标签。

- Jacob van Lingen