national-motion-backend/编码规范.md

开发环境

• Java17
• maven3.6+

公共约定

1. 所有方法返回值必须使用包装类Result，并指明其泛型T
2. 所有service不允许调用service,目业务逻辑只允许在service中出现
3. 需要依赖注入的类，强烈建议使用构造注入
4. 业务代码关键模糊/多意的地方必须带有注释
5. 非业务接口必须要以IX开头
6. 抽像类必须要以AX开头
7. 尽量不要使用Object作为泛型
8. 如多个参数或者响应体，能明确个数时。强烈建议使用定长数组
9. 去除没有用到的类引用
10. 不要客惜废弃的老代码
11. 请不要写几余无用的代码。if(true)之类的代码块完全不应该出现，用空行隔开该段代码是更好的选择
12. ,请合理运用空行。空行可以用来隔开相对独立的代码块，有利于阅读和理解。但是不要使用超过一行的空行，对空间，别太警侈了
13. 请不要在两个地方出现完全相同的代码
14. 命名类，方法，变量值用简写，除非大家都人认
15. 把所有的类变量放到最前面，如果比较多请按用途分组排列
16. 拆分大的类，大的方法 千万不要堆出千行代码类!!!!

类注释模板

/**
 * <p>类注释</p>
 * @author 作者
 * 时间：xxxx年xx月xx日
 */

方法注释模板

/**
 * <p>描述</p>
 * @author 作者
 * @param 参数描述，参数为类则包含{@link Object}
 * @param...
 * @return 返回值描述，如无返回值则为void 返回值为类则包含{@link object}
 * 
 */

项目协同开发公共约定参照

project

代码提交说明请按照

1、feat: 新功能（feature）例如：feat: 添加用户登录功能 2、fix: 修复bug例如：fix: 修复登录页面无法提交的问题 3、docs: 文档更新例如：docs: 更新README.md 4、style: 代码格式调整（不影响代码运行的变动）例如：style: 调整代码缩进和空格 5、refactor: 重构代码（既不是新增功能，也不是修改bug的代码变动）例如：refactor: 重构用户服务类 6、perf: 性能优化 例如：perf: 优化数据库查询性能 7、test: 增加测试用例 例如：test: 添加用户注册单元测试 8、chore: 构建过程或辅助工具的变动 例如：chore: 更新依赖包版本 9、revert: 回滚之前的提交 例如：revert: 回滚到上一个版本 10、build: 构建系统或外部依赖的更改例如：build: 升级Maven依赖