Java注释的使用方法

一、单行注释

单行注释以'//'开头，一直到当前行末尾为止，用于注释单行代码或单独一行的注释，例如：

// 定义变量i并初始化为10
int i = 10;

单行注释可在代码后面或单独成行进行使用，为了提高可读性，通常建议将注释独立成一行。

二、多行注释

多行注释以'/*'开头，以'*/'结尾，用于注释多行代码及注释，例如：

/*
 * 计算圆的面积和周长
 */
double r = 5.0; // 半径
double area = Math.PI * r * r; // 面积
double circumference = 2 * Math.PI * r; // 周长

多行注释可以覆盖多行代码及注释，可以用于注释整个方法或类的内容。

三、文档注释

文档注释以'/**'开头，以'*/'结尾，用于为Java程序添加HTML格式的注释文档，可以通过JavaDoc工具生成API文档，例如：

/**
 * 计算圆的面积和周长
 *
 * @param r 半径
 * @return 返回长度为2的double数组，数组的第一个元素表示圆的面积，第二个元素表示圆的周长
 * @throws IllegalArgumentException 当半径小于等于0时抛出此异常
 */
public static double[] calculate(double r) throws IllegalArgumentException {
    if (r <= 0) {
        throw new IllegalArgumentException("半径不能小于等于0");
    }
    double area = Math.PI * r * r; // 面积
    double circumference = 2 * Math.PI * r; // 周长
    return new double[]{area, circumference}; // 返回值为数组
}

文档注释通过@开头的标签来描述程序元素的说明信息，包括@param、@return、@throws等，可以为其他开发人员提供详细的API说明文档。

四、注意事项

在编写注释时，应注意以下几点：

1. 注释应该清晰、简洁、明了，避免冗长或过于复杂的注释。

2. 注释应该与代码相匹配，即注释应该与代码同步更新，防止注释与代码不一致的情况。

3. 在注释中避免使用口水话或个人性质的句子，应该使用专业术语和客观、中立的语言。

五、总结

Java注释是Java程序中必不可少的部分，实现了对Java程序元素的解释、说明和描述，提高了代码的可读性和可维护性。在程序编写过程中，注释应该清晰、简明、与代码相符，以便于其他开发人员或自己更好地理解代码。