Eclipse配置Javadoc_eclipse设置javadoc-CSDN博客

本文链接：https://blog.csdn.net/octopusflying/article/details/52529776

本文介绍了如何在Eclipse中配置和使用Javadoc工具，通过详细步骤展示了从设置Javadoc.exe路径到生成Java项目的html文档的过程，包括类、字段和方法的注释展示。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Java中有一种新型的注释方法 —— 用 /** 和 */ 包围注释内容。这种新型的注释方式，可以通过采用 JDK 包含的Javadoc工具生成用于说明项目信息的html页面。我们常用的Java Api 就是用javadoc生成的：

集成开发环境Eclipse具有调用Javadoc生成说明文档的功能。配置步骤如下：

    (1) 启动Eclipse，在菜单栏中选择：File -> Export:

(2) 在弹出的对话框中选择：Java -> Javadoc

(3) 如果是第一次使用这个功能，首先需要配置Javadoc.exe程序的路径。这个程序位于JDK目录下的bin文件夹中：

配置工作完成。

(4) 接下来是使用Javadoc功能的样例，首先给出一个用于实验的Java项目样例：

项目中包含了一个报test，包中包含了一个类Test，Test的代码如下：

package test;
import java.util.Scanner;

/**
 * This is the Test class.
 * @version 2016-09-13
 * @author Octopusfly
 */
public class Test {
    /**
     * The description of field1.
     */
    private int field1;
    
    /**
     * This description of static field s.
     */
    private static int s;
    
    /**
     * The constructor without paramters.
     */
    public Test() {
        
    }
    
    /**
     * The constructor with one parameter.
     * @param p The parameter in constructor.
     */
    public Test(int p) {
        field1 = p;
    }
    
    /**
     * This is the function f.
     * @param p1 This is the parameter-1.
     * @param p2 This is the parameter-2.
     * @return This is the return value.
     */
    public int f(int p1, int p2) {
        return 0;
    }
}  
注意代码中的注释。

(5) 然后，对于test包也给出一个注释，这里包的注释需要用单独的html文件来记录，package.html文件的内容如下：
<body>
	The description of the package test.
</body> 
注解添加完成。

(6) 打开步骤(3)中的对话框，可以选择要生成文档的Java项目，同时设定生成的说明文档的存储路径(笔者放在了桌面):

(7) 点击Finish开始生成，控制台中可以看到进度：

(8)执行完毕后，点击生成的index.html文件：

(9)此时可以在打开的页面中看到我们之前添加的注释内容：