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;
}

注释的注意事项

• 单行注释和多行注释不会被编译器处理，仅用于代码说明。
• 文档注释可以通过Javadoc工具生成HTML格式的API文档。
• 避免嵌套多行注释（如 /* /* */ */），会导致编译错误。
• 注释应清晰简洁，避免过度注释或无意义的注释。