Java 文档注释

Java 文档注释

Java 文档注释，通常称为 Javadoc，是 Java 编程语言中一种特殊的注释类型，用于生成 API 文档。Javadoc 允许开发者在源代码中嵌入注释，这些注释随后可以被 Javadoc 工具解析，生成格式化的 HTML 文档。这种文档对于理解和使用 Java 类库、框架和 API 非常重要。

Javadoc 注释的基本结构

Javadoc 注释以 /** 开始，以 */ 结束。每个 Javadoc 注释通常包含以下几个部分：

1. 描述：对类、方法或成员变量的简要描述。
2. 标签：用于提供更多信息的特殊标记，如 @param、@return、@throws 等。
3. 示例代码（可选）：展示如何使用类或方法的代码片段。

类注释

类注释位于类定义之前，提供类的总体描述。例如：

/**
 * This class represents a simple calculator.
 * It provides methods for basic arithmetic operations.
 */
public class Calculator {
    // ...
}

方法注释

方法注释位于方法定义之前，描述方法的功能、参数和返回值。例如：

/**
 * Adds two integers and r