当前位置：首页 > Java

java如何生成文档

2026-03-03 20:01:05Java

使用Javadoc生成文档

Javadoc是Java自带的文档生成工具，通过解析源代码中的特殊注释生成HTML格式的API文档。在类、方法、字段前添加以/开头的注释，Javadoc会提取这些注释并生成文档。

/
 * 这是一个示例类，用于演示Javadoc注释。
 */
public class Example {
    /
     * 计算两个整数的和。
     * @param a 第一个加数
     * @param b 第二个加数
     * @return 两个参数的和
     */
    public int add(int a, int b) {
        return a + b;
    }
}

在命令行中运行以下命令生成文档：

javadoc -d doc Example.java

使用Maven生成文档

在Maven项目中，可以通过maven-javadoc-plugin插件生成文档。在pom.xml中添加以下配置：

java如何生成文档

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.3.2</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

运行以下命令生成文档：

mvn javadoc:javadoc

使用Gradle生成文档

在Gradle项目中，可以通过javadoc任务生成文档。在build.gradle中添加以下配置：

java如何生成文档

tasks.withType(Javadoc) {
    options.encoding = 'UTF-8'
}

运行以下命令生成文档：

gradle javadoc

使用第三方工具生成文档

Doxygen是一个支持多种语言的文档生成工具，可以生成更丰富的文档格式。安装Doxygen后，在项目根目录创建Doxyfile配置文件，运行以下命令生成文档：

doxygen Doxyfile

Swagger适用于生成RESTful API文档。在Spring Boot项目中，可以通过springfox-swagger2和springfox-swagger-ui依赖生成交互式API文档。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

在配置类中添加@EnableSwagger2注解，启动项目后访问http://localhost:8080/swagger-ui.html查看文档。