java如何打注释

Java注释的三种方法

单行注释使用双斜杠//，适用于简短说明或临时注释单行代码。

// 这是单行注释
int x = 10; // 变量x赋值为10

多行注释以/*开头、*/结尾，适合注释代码块或详细说明。

/* 
这是多行注释
可以跨越多行
*/
System.out.println("Hello");

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

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

注释的最佳实践

注释内容应清晰简洁，避免冗余描述。重点解释代码的意图而非重复代码行为。

// 错误示例：冗余注释
int count = 0; // 将count设置为0

// 正确示例：解释原因
int retryAttempts = 3; // 根据服务端要求设置最大重试次数

对于复杂算法或特殊处理逻辑，使用多行注释详细说明实现原理。

/* 
使用快速排序算法优化性能：
1. 选取基准值避免最坏情况
2. 对小数组切换插入排序
*/

文档注释需遵循标准标签（如@param、@return），便于生成规范的API文档。

/
 * 转换字符串为日期对象
 * @param dateStr 格式必须为"yyyy-MM-dd"
 * @throws IllegalArgumentException 输入格式错误时抛出
 */