eclipse如何生成java文档

在 Eclipse 中生成 Java 文档（Javadoc）通常有以下几种常用方式：

一、使用 Eclipse 自动生成 Javadoc（最常用）

步骤：

1. 选中项目 / 包 / 类

   • 在 Package Explorer 中右键点击目标（项目、包或类）

2. 选择：

   Export → Java → Javadoc → Next
   

3. 配置 Javadoc 生成选项：

   • Javadoc command：选择 JDK 中的 javadoc.exe

     <JDK路径>/bin/javadoc.exe
     

   • Visibility：选择 public / protected（一般选 protected）
   • Destination：选择生成文档的目录（如 doc/）

4. 点击 Finish

5. 生成完成后，打开：

   <输出目录>/index.html
   

二、使用工具栏 / 快捷键生成

1. 选中类或方法
2. 菜单：

   Project → Generate Javadoc
   

三、使用 Maven 项目生成 Javadoc（推荐 Maven 项目）

1. 使用 mvn javadoc

mvn javadoc:javadoc

生成位置：

target/site/apidocs/index.html

2. 使用 Maven 插件（pom.xml）

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.5.0</version>
    <configuration>
        <encoding>UTF-8</encoding>
    </configuration>
</plugin>

四、编写规范的 Javadoc 注释（重要）

Eclipse 才能生成高质量文档：

/**
 * 计算两个整数之和
 *
 * @param a 第一个数
 * @param b 第二个数
 * @return 和
 */
public int add(int a, int b) {
    return a + b;
}

自动生成注释快捷键：

输入 /** 然后按 Enter

五、常见问题

1. 中文乱码

在 Javadoc 配置中设置：

-encoding UTF-8 -charset UTF-8

2. 找不到 javadoc.exe

确认 Eclipse 使用的是 JDK，而不是 JRE：

Window → Preferences → Java → Installed JREs

如果你愿意，我可以：

• 给你 完整 Javadoc 示例
• 教你 导出 HTML / PDF
• 配置 企业级 JavaDoc 模板

你用的是普通 Java 项目还是 Maven 项目？