当前位置：首页 > Java

java如何填写注释

2026-03-23 22:51:32Java

Java 注释填写方法

Java 注释分为单行注释、多行注释和文档注释三种类型，每种注释有不同的使用场景和规范。

单行注释

使用 // 开头，适用于简短说明或临时注释代码：

java如何填写注释

// 计算两个数的和
int sum = a + b;

多行注释

使用 /* */ 包裹，适用于较长的注释说明或临时屏蔽代码块：

/*
 * 这是一个多行注释示例
 * 可以跨越多行说明复杂逻辑
 */

文档注释

使用 / */ 包裹，用于生成 API 文档（通过 javadoc 工具）。主要包含以下结构化标签：

java如何填写注释

/
 * 计算两个整数的和
 * 
 * @param a 第一个加数
 * @param b 第二个加数
 * @return 两个参数的和
 * @throws IllegalArgumentException 当参数为负数时抛出
 */
public int add(int a, int b) {
    if (a < 0 || b < 0) {
        throw new IllegalArgumentException("参数不能为负数");
    }
    return a + b;
}

文档注释常用标签

@param：描述方法参数
@return：描述返回值
@throws/@exception：描述可能抛出的异常
@see：添加相关参考链接
@deprecated：标记已过时的方法
@version：版本信息
@author：作者信息

注释规范建议

类注释应包含类功能描述、作者和版本信息：

/
 * 用户管理类，提供用户增删改查功能
 * 
 * @author ZhangSan
 * @version 1.0
 */
public class UserService {
    // 类实现...
}

方法注释应清晰描述功能、参数、返回值和异常：

/
 * 根据ID查询用户信息
 * 
 * @param userId 用户ID
 * @return 用户对象，未找到时返回null
 * @throws SQLException 数据库访问异常
 */
public User getUserById(int userId) throws SQLException {
    // 方法实现...
}