1. 概述
众所周知，编写清晰且全面的文档对于代码维护至关重要。在Java中，我们可以通过使用Javadoc来实现这一点，这是一种可以从Java源代码注释生成HTML文件的文档生成器。
在这个教程中，我们将学习如何使用Gradle，一个流行的构建自动化工具，来生成Javadoc。
2. 设置Gradle项目
简单来说，设置一个Gradle项目非常容易。首先，我们需要在机器上安装Gradle构建工具。接下来，创建一个空文件夹并通过终端切换到该文件夹。然后，通过终端初始化一个新的Gradle项目：
$ gradle init
命令会询问一些问题来设置项目。我们将选择应用模板作为项目类型生成。接着，选择Java作为实现语言和Groovy作为构建脚本。最后，我们将使用默认的测试框架，即JUnit 4，并给我们的项目命名。
或者，我们也可以使用IntelliJ IDEA来生成Gradle项目。为此，我们创建一个新的项目并选择Gradle作为构建系统。它会自动生成包含所有必需文件夹的项目。
3. 项目设置
初始化Gradle项目后，让我们用最喜欢的IDE打开项目。接下来，我们将创建一个名为addition的新包，并添加一个名为Sum的类：
package com.baeldung.addition
/**
* This is a sample class that demonstrates Javadoc comments.
*/
public class Sum {
/**
* This method returns the sum of two integers.
*
* @param a the first integer
* @param b the second integer
* @return the sum of a and b
*/
public int add(int a, int b) {
return a + b;
}
}
这个类演示了简单的加法功能。我们创建了一个add()方法，它接受两个参数并返回参数的和。
此外，我们在注释中添加了介绍性文档，并在多行注释中描述了add()方法。我们指定了它接收的参数和返回的值。
接着，我们创建另一个名为subtraction的包，并添加一个名为Difference的类：
package com.baeldung.subtraction
/**
* This is a sample class that demonstrates Javadoc comments.
*/
public class Difference {
/**
* This method returns the difference between the two integers.
*
* @param a the first integer
* @param b the second integer
* @return the difference between a and b
*/
public int subtract(int a, int b) {
return a - b;
}
}
这个类演示了一个简单的功能，用于找出两个Integer之间的差值。
在下一节中，我们将学习如何通过指定包含和排除的包来生成Javadoc。
5. 通过Gradle生成Javadoc
现在我们有了带有文档注释的示例项目，我们想要通过Gradle生成Javadoc。要做到这一点，我们需要在gradle.build文件中添加一些配置。这个文件包含了项目的配置，如插件、依赖项、项目组、版本等。
首先，让我们将Java插件应用于项目：
plugins {
id 'java'
}
这告诉Gradle使用Java插件。Java插件使得开发Java应用程序更加轻松，并提供了诸如编译、代码测试、Javadoc任务等功能。
此外，我们将在gradle.build文件中添加Javadoc任务的代码：
javadoc {
destinationDir = file("${buildDir}/docs/javadoc")
}
这配置了Javadoc任务，并指定了生成文档的构建目录。
我们还可以配置Javadoc任务在运行任务时包括和排除包：
javadoc {
destinationDir = file("${buildDir}/docs/javadoc")
include 'com/baeldung/addition/**'
exclude 'com/baeldung/subtraction/**'
}
这里，我们包括addition包并排除subtraction包。**include和exclude属性允许我们选择Javadoc任务中所需的包**。
最后，要在终端中生成文档，我们打开根目录，然后运行Gradle构建命令：
./gradlew javadoc
此命令执行Javadoc任务并以HTML格式生成文档。HTML文件存储在指定的文件夹中。
以下是一个HTML文件文档的例子：
6. 总结
在这篇文章中，我们学习了如何使用Gradle构建系统生成Javadoc。我们还了解了如何为两个Java类编写文档注释。此外，我们还学习了如何配置Javadoc以包括和排除包。
如往常一样，示例代码的完整源代码可在GitHub上找到。