Java注释

Java注释是源代码中用于解释代码功能、提高可读性的非执行文本。注释不会被编译器处理，但对开发者维护代码和理解逻辑至关重要。Java支持三种注释类型：单行注释、多行注释和文档注释。

注释类型[编辑 | 编辑源代码]

1. 单行注释[编辑 | 编辑源代码]

以//开头，仅注释当前行内容。适用于简短说明。

  
public class Main {  
    public static void main(String[] args) {  
        // 输出"Hello World"到控制台  
        System.out.println("Hello World");  
    }  
}

2. 多行注释[编辑 | 编辑源代码]

以/*开头、*/结尾，可跨越多行。常用于复杂逻辑说明。

  
/*  
 * 这是一个多行注释示例  
 * 计算两个数的和  
 */  
public int add(int a, int b) {  
    return a + b;  
}

3. 文档注释[编辑 | 编辑源代码]

以/**开头、*/结尾，用于生成API文档（通过javadoc工具）。支持HTML标签和Javadoc标签（如@param、@return）。

  
/**  
 * 计算两个整数的乘积  
 * @param a 第一个乘数  
 * @param b 第二个乘数  
 * @return 返回a与b的乘积  
 */  
public int multiply(int a, int b) {  
    return a * b;  
}

实际应用场景[编辑 | 编辑源代码]

代码维护[编辑 | 编辑源代码]

注释帮助团队理解代码意图，例如：

  
// 使用快速排序算法优化性能（时间复杂度O(n log n)）  
void sort(int[] array) {  
    Arrays.sort(array);  
}

API文档生成[编辑 | 编辑源代码]

通过文档注释生成HTML文档： 1. 编写包含@param和@return的注释。 2. 运行命令：javadoc Main.java。

注释规范[编辑 | 编辑源代码]

清晰简洁：避免冗余描述。
及时更新：修改代码时同步更新注释。
避免过度注释：仅对复杂逻辑或非直观代码添加注释。

反例[编辑 | 编辑源代码]

  
// 给i加1  
i++;  // 无意义的注释

注释与代码结构的关系[编辑 | 编辑源代码]

数学公式示例（可选）[编辑 | 编辑源代码]

若需在注释中描述算法公式，可使用LaTeX语法： $\sum_{i = 1}^{n} (x_{i} + y_{i})$

总结[编辑 | 编辑源代码]

Java注释是提升代码可维护性的关键工具，合理使用单行、多行和文档注释能显著提高团队协作效率。初学者应从基础注释开始，逐步掌握文档注释的规范写法。