【问题标题】:How to generate Javadoc HTML files in Eclipse?如何在 Eclipse 中生成 Javadoc HTML 文件?
【发布时间】:2011-05-27 00:03:40
【问题描述】:

我已经在我的项目代码中编写了这样的 Javadoc 样式 cmets:

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

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

【问题讨论】:

标签: java eclipse javadoc


【解决方案1】:
  1. 项目 > 生成Javadoc....

  2. Javadoc command: 字段中,浏览以找到 javadoc.exe(通常位于 [path_to_jdk_directory]\bin\javadoc.exe em>)。

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

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

  5. 点击完成

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

【讨论】:

  • Java JDK需要安装吗?我已经安装了 Java 并且可以在 Eclipse 中创建 Java 程序...但是 javadoc.exe 在我的驱动器上的任何地方都不存在!
  • 旧,但对于将来可能对此感到困惑的任何人,请检查您是否安装了 JDK 而不是 JRE(在此位置不包含 javadoc.exe)。
【解决方案2】:

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

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

  1. 转到 帮助 > Eclipse Marketplace...
  2. 找到“JAutodoc”。
  3. 安装它并重新启动 Eclipse。

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

【讨论】:

  • AFAIK,JAutodoc 不会从现有的 javadoc cmets 生成 HTML(这是问题所要求的),而是帮助生成 javadoc cmets。
  • Eclipse 会让你生成 Javadocs:Project -> Generate Javadocs...
  • 这只会生成 javadoc 而不是问题所在的 html。
【解决方案3】:

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

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

    javadoc YourClassName.java

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

    javadoc *.java

【讨论】:

    【解决方案4】:

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

    Windowsalt + shift + J

    Mac + Alt + J

    根据选定的上下文,将打印一个 Javadoc。要创建OP编写的Javadoc,选择相应的方法并点击快捷键。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2012-07-04
      • 2010-12-19
      • 2011-01-25
      • 2011-03-24
      • 2012-09-16
      • 1970-01-01
      • 2012-04-15
      • 2016-10-15
      相关资源
      最近更新 更多