java 中如何注释

单行注释

在 Java 中，单行注释以双斜杠 // 开头，从 // 开始到行尾的内容都会被编译器忽略。单行注释通常用于对单行代码进行简短说明。

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

多行注释

多行注释以 /* 开头，以 */ 结尾，中间的所有内容都会被编译器忽略。多行注释适用于需要跨越多行的详细说明。

/*
这是一个多行注释
可以跨越多行
通常用于方法或类的详细描述
*/
int y = 20;

文档注释

文档注释以 / 开头，以 */ 结尾，通常用于生成 API 文档（如 Javadoc）。文档注释可以包含 HTML 标签和 Javadoc 标签（如 @param、@return 等）。

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

注释的注意事项

注释内容应简洁明了，避免冗余或无意义的描述。单行注释通常用于代码行的简短说明，多行注释用于逻辑块或复杂逻辑的说明，文档注释用于公共 API 的正式文档生成。

注释不应替代清晰的代码命名和结构，良好的代码本身应该是自解释的。注释仅用于补充说明代码的意图或复杂逻辑的背景信息。