如何添加java注释

单行注释

单行注释以双斜杠 // 开头，适用于简短说明或临时注释代码：

// 这是一个单行注释
int x = 10; // 声明并初始化变量x

多行注释

多行注释以 /* 开头、*/ 结尾，适用于较长的注释或临时屏蔽代码块：

/* 
这是一个多行注释示例，
可以跨越多行描述复杂逻辑。
以下代码被暂时禁用：
int y = 20;
System.out.println(y);
*/

文档注释

文档注释以 / 开头、*/ 结尾，用于生成API文档（通过javadoc工具）：

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

特殊标签说明

文档注释支持标准标签增强可读性：

• @param 描述方法参数
• @return 描述返回值
• @throws 描述可能抛出的异常
• @see 添加相关参考链接

/
 * 读取文件内容
 * @param filePath 文件路径字符串
 * @return 文件内容字符串
 * @throws IOException 当文件不存在时抛出
 * @see java.io.FileReader
 */

注释最佳实践

1. 公共API必须使用文档注释
2. 复杂算法建议使用多行注释解释逻辑
3. 避免无意义的注释（如i++ // 增加i）
4. 维护代码时同步更新相关注释
5. 使用英文编写注释保持团队一致性