java如何插入注释

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

注释的使用场景建议

• 调试临时注释：使用单行注释快速禁用某行代码。
• 方法功能说明：用文档注释描述参数、返回值及用途。
• 复杂逻辑解释：用多行注释在关键代码段添加说明。

注意事项

• 多行注释不可嵌套，如 /* /* 嵌套 */ */ 会导致语法错误。
• 文档注释的标签（如 @param）需遵循 Javadoc 规范。
• 注释应清晰简洁，避免冗余信息。