JDK 中的 Javadoc 使用详解

# 1.1 Javadoc 简介

Javadoc 是一种文档生成工具，用于为 Java 程序生成 API 文档。它通过解析 Java 源代码中的特殊注释（称为 Javadoc 注释）来提取信息，并生成 HTML、PDF 或其他格式的文档。Javadoc 注释以 `/**` 和 `*/` 标记，包含有关类、方法、字段和其他 Java 元素的信息。

# 2. Javadoc 注释的类型和作用

Javadoc 注释是 Java 编程语言中用于生成 API 文档的特殊注释。它们提供有关类、方法和字段的信息，帮助开发人员理解和使用代码。Javadoc 注释以 `/**` 和 `*/` 符号开头和结尾，并包含一个或多个标记。

### 2.1 类注释

类注释用于描述类的整体信息，包括其作者、版本和用途。

#### 2.1.1 @author

`@author` 标记用于指定类的作者。它可以包含一个或多个作者的姓名，用逗号分隔。

**示例：**

/**
 * @author John Doe, Jane Doe
 */
public class MyClass {
    // ...
}

#### 2.1.2 @version

`@version` 标记用于指定类的版本。它可以包含版本号或版本日期。

**示例：**

/**
 * @version 1.0
 */
public class MyClass {
    // ...
}

### 2.2 方法注释

方法注释用于描述方法的输入、输出和行为。

#### 2.2.1 @param

`@param` 标记用于描述方法的参数。它可以包含参数的名称、类型和描述。

**示例：**

/**
 * Calculates the area of a circle.
 *
 * @param radius the radius of the circle
 */
public double calculateArea(double radius) {
    // ...
}

#### 2.2.2 @return

`@return` 标记用于描述方法的返回值。它可以包含返回值的类型和描述。

**示例：**

/**
 * Calculates the area of a circle.
 *
 * @return the area of the circle
 */
public double calculateArea(double radius) {
    // ...
}

### 2.3 字段注释

字段注释用于描述类的字段。

#### 2.3.1 @see

`@see` 标记用于链接到另一个类或方法的文档。它可以包含一个或多个类或方法的名称，用逗号分隔。

**示例：**

/**
 * The name of the user.
 *