点击空白处退出提示
作品详情
一、社银平台代码规范
社银平台代码规范目前是使用阿里规约扫描+idea只带检测
(Alibaba Java Coding Guidelines)
代码不允许警告提示不去处理,除非是误警报
1、代码注释
Controller 控制层每个入口必须写明是干什么用的
Service 接口层必须写明作用和目的,实现层如果有复杂业务逻辑也必须写明注释
Dao 层因为使用的是mybaits或mybatis+mybatisPlus,所以没有实现层,但有xml文件,建议接口和xml文件都必须写上注释,建议安装mybatis插件,方便xml和接口上下切换(例如插件:mybatisX)
2、git提交commit message信息
建议把这个hook放在项目的.git/hooks里面,这个脚本会对提交commit message格式进行校验
3、项目结构在readme.md里面已经有说明
声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态
评论