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

时间:2010-12-17 08:03:12

标签: java eclipse javadoc

我在我的项目代码中编写了这样的Javadoc样式注释:

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

如何使用Eclipse IDE生成Javadoc HTML文件?

4 个答案:

答案 0 :(得分:225)

  1. Project > 生成Javadoc ...

  2. Javadoc命令:字段中,浏览以查找 javadoc.exe (通常位于 [path_to_jdk_directory] ​​\ bin \ javadoc.exe )。

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

  4. 目的地:字段中,浏览以查找所需的目的地(例如,当前项目的根目录)。

  5. 点击完成

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

答案 1 :(得分:9)

这是与OP相关的补充答案:

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

  1. 转到帮助> Eclipse Marketplace ...
  2. 查找" JAutodoc"。
  3. 安装它并重新启动Eclipse。
  4. 要使用此工具,请右键单击类,然后单击 JAutodoc

答案 2 :(得分:4)

您也可以通过命令行轻松完成。

  1. 从文件夹/包中打开命令行。
  2. 从命令行运行:

    javadoc YourClassName.java

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

    javadoc * .java

答案 3 :(得分:-1)

要快速添加Javadoc,请使用以下快捷方式:

Windows alt + shift + J

Mac + Alt + J

根据选定的上下文,将打印Javadoc。要创建由OP编写的Javadoc,请选择相应的方法并按下shotcut键。