一，注释的作用
1.代码说明：解释代码功能，逻辑，思路，方便自己和他人阅读·
2.调试代码：临时注掉某段代码，排查bug
3.规范文档：文档注释可自动生成API帮助文档
4.屏蔽无效代码：保留旧代码，暂时不执行
二，用法
1.单行注释
1. 单行注释
- 格式：// 注释文字
- 范围：从 // 开始到本行末尾生效。
- 使用场景：单行说明、行内补充注释。
// 定义整型变量
int num = 100;
String name = "张三"; // 存储姓名
2.多行注释
- 格式：/* 多行内容 */
- 范围：中间所有内容都被注释，可跨多行。
- 使用场景：大段代码说明、临时注释整块代码。
- 注意：不能嵌套使用。
/*
下面这段代码用于计算两数乘积
临时注释，暂时不运行
*/
/* 错误示范：嵌套注释 */
3.文档注释
- 格式：开头 /**，结尾 */，每行一般以 * 开头排版。
- 特点：专属 Java，可提取为官方 API 文档，支持文档标签。
- 使用场景：类、方法、常量、接口上方（项目规范必备）。
/**
* 工具类：简单运算
* @author 程序员
* @version 1.0
*/
public class Calc {
/**
* 加法运算
* @param a 第一个整数
* @param b 第二个整数
* @return 两数相加结果
*/
public int plus(int a, int b){
return a + b;
}
}
常用标签：
- @author：作者，用于类 / 接口
- @version：版本号，用于类 / 接口
- @param 参数名 说明：描述方法参数，一个参数写一条
- @return 说明：描述返回值，void 方法不能用
- @throws 异常类名 说明：描述方法抛出的异常
