编码规范

• 1、SVN代码提交和修改规范

jeecg-boot-module-system/docs/规范/编码必看规范

• 2、代码注释规范

类注释、方法名\参数注释 、实体字段注释 （合理的代码结构、分层、命名、注释）

参考： https://my.oschina.net/jeecg/blog/3198358

• 3、代码格式化说明

新增代码必须格式化，老代码禁止格式化

• 4、Review规范 review问题，及时记比较以免忘记（有道云、图文并茂）

• 5、代码规范扫描 代码扫描检查插件安装： pc3

1、不允许代码里面写变量值，需要使用常量定义（统一变量文件或者一个模块一个常量文件）
2、复杂代码逻辑，要增加步骤说明
3、类命名、参数、字段命名要明确，可以百度翻译驼峰缩写

jeecg-boot-module-system/docs/规范/阿里巴巴Java开发手册（详尽版）.pdf

• 阿里巴巴Java开发手册（精简实用）
• 阿里巴巴Java开发手册 下载

• 6、TODO 规范，记录缺陷点（及时纠正）

代码有缺陷或者未完善的地方，加TODO标记（前端、后端都适用）

• 7、建表规范

jeecg-boot-module-system/docs/规范/设计样板/JEECG-开发说明书-XX模块-建表规范v1.0.xlsx

• 8、开源issue处理

 回复issue具体修复问题方法 或 回复下个版本修复