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


Answers:


234
  1. Project> Generate Javadoc...

  2. 在该Javadoc command:字段中,浏览以找到javadoc.exe(通常在[path_to_jdk_directory] ​​\ bin \ javadoc.exe中)。

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

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

  5. 点击Finish

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


1
是否需要安装Java JDK?我已经安装了Java,并且可以在Eclipse中创建Java程序...但是javadoc.exe驱动器上的任何地方都不存在!
AlainD

很老,但是对于将来可能对此感到困惑的任何人,请检查是否安装了JDK,而不是JRE(此位置不包含javadoc.exe)。
omoshiroiii

9

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

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

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

要使用此工具,请在class上单击鼠标右键,然后单击JAutodoc


7
AFAIK,JAutodoc不会从现有的javadoc注释生成HTML(这是问题的要求),而是有助于生成Javadoc注释。
Amani Kilumanga '16

3
答案与问题无关,但这正是我一直在寻找的问题:)
keya

Eclipse将让您生成Javadocs:项目->生成Javadocs ...
pongapundit

这只会生成javadoc,而不生成问题所在的html。
Ashish

5

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

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

    javadoc YourClassName.java

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

    javadoc * .java


2

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

Windowsalt+ shift+J

Mac+ Alt+J

根据所选上下文,将打印Javadoc。要创建由OP编写的Javadoc,请选择相应的方法,然后按快捷键。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.