发际线总和我作队——Beta冲刺代码规范

[发际线总和我作队]

这个作业属于哪个课程	2501_CS_SE_FZU
这个作业要求在哪里	团队作业—Beta冲刺
这个作业的目标	明确团队的代码规范
其他参考文献	《阿里巴巴Java开发手册终极版v1.3.0》

目录

• 1 代码规范
• 1.1 命名规范
• 1.2 异常处理规范
• 1.3 注释规范
• 1.4 控制器规范
• 1.5 数据库操作规范
• 1.6 其他规范

1 代码规范

1.1 命名规范

类名：使用大驼峰命名法（UpperCamelCase）
方法名：使用小驼峰命名法（lowerCamelCase）
变量名：使用小驼峰命名法（lowerCamelCase）
常量名：全部大写，单词间用下划线隔开
包名：全部小写
杜绝完全不规范的缩写

1.2 异常处理规范

使用自定义异常
统一异常处理，返回明确的错误码和消息
在Service层进行业务校验和异常抛出

1.3 注释规范

每个类都有类级别的文档注释
方法都有方法功能的简要说明
使用JavaDoc格式的注释
关键业务逻辑有行内注释

1.4 控制器规范

使用 @RestController 注解
统一的URL前缀 @RequestMapping
明确的HTTP方法注解（@GetMapping、@PostMapping等）
使用 @PathVariable 和 @RequestBody 注解

1.5 数据库操作规范

在Mapper接口中定义数据访问方法
使用MyBatis注解或XML配置
方法命名体现操作意图

1.6 其他规范

使用合适的访问修饰符（public、private）
字段封装，使用getter/setter方法
保持方法单一职责
适当的空行分隔代码块，提高可读性