java如何备注
注释语法
Java支持两种注释方式:单行注释和多行注释。
单行注释:以 // 开头,直到行尾。

// 这是单行注释
int x = 10; // 也可以跟在代码后
多行注释:以 /* 开头,以 */ 结尾,可跨多行。

/*
这是多行注释
可以写多行内容
*/
int y = 20;
文档注释
Java提供特殊的文档注释(Javadoc),以 / 开头,以 */ 结尾,用于生成API文档。
/
* 计算两数之和
* @param a 第一个加数
* @param b 第二个加数
* @return 两数之和
*/
public int add(int a, int b) {
return a + b;
}
常用Javadoc标签:
@param:描述方法参数。@return:描述返回值。@throws:描述可能抛出的异常。@deprecated:标记方法已过时。
注释规范
- 代码逻辑注释:解释复杂逻辑或算法,避免冗余描述。
- 方法注释:使用Javadoc格式,说明方法功能、参数及返回值。
- 类注释:在类定义前使用Javadoc,描述类的用途和作者信息。
/
- 表示一个用户实体类
- @author ZhangSan
*/
public class User {
// 类内容
}
- 避免过度注释:代码应尽量自解释,注释仅补充必要信息。






