java如何添加注释

Java 注释的添加方法

Java 支持三种注释方式，分别适用于不同场景。以下是具体用法和示例：

单行注释

以 // 开头，仅注释当前行内容：

int x = 5; // 声明并初始化变量x

多行注释

用 /* */ 包裹多行内容：

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

文档注释

以 / */ 包裹，用于生成 API 文档：

/
 * 表示一个二维点坐标
 */
class Point {
    / x 坐标值 */
    double x;

    / y 坐标值 */
    double y;
}

注释使用建议

• 方法或类建议使用文档注释说明功能、参数和返回值
• 复杂逻辑建议使用多行注释解释实现原理
• 临时调试可用单行注释快速禁用代码段

文档注释支持 Javadoc 标签如 @param、@return、@throws 等，可通过 javadoc 命令生成 HTML 文档。