规范开发初版
# (1)命名规范
1、不允许出现拼音缩写、汉语拼音(cg、fk、caigou、fukuan)等词汇。
2、不允许出现非标准英文缩写。
3、变量不允许出现数字、下划线等。如:user_Name、user_name、name1、name2等。特殊参照下面。
4、单一函数里面可以用默认名称。上下文清晰,代码行数少逻辑单,如:ArrayList list,可以用list来做命名。
5、多个单次的命名方式用驼峰式。在可能的情况下,尽量不要出现方法、函数、变量名称过长。追求单一原则。
6、常量必须全部大写,单次下划线隔开区分。
7、类名命名方式,尽量类名就能看出是哪些部分的。如订单用Order开头。登录用Login开头等。
8、每种类型的类必须用每种类型的单词结束。比如异常类用Exception结束、测试用Test结束等。
9、实现类必须Impl结束。特殊接口除外。
10、继承类注意父类变量名,勿重名。
# (2)代码格式规范
1、代码格式规范全员用统一的代码格式规范。(比如我们正在用的IDEA,那就用IDEA自带的格式化代码)。
2、表示层不允许出现任何业务逻辑代码。完全遵照三层架构的基本原则设计代码。
3、很多小伙伴喜欢在出现异常的时候处理或者其他操作提示的时候,喜欢直接输出汉字。除了注释禁止出现中文。使用常量。
# (3)注释规范
1、所有函数方法都要用/**回车进行注释。注释里面包含信息如下。
①方法功能简要描述
②返回值
③参数
④创建时间
⑤创建人
2、方法中尽量不要单行注释代码。实体类除外。(特殊情况特殊对待)
3、注释尽量还是用团队的母语最佳。
# (4)方法设计规范
1、方法体不允许超过50行代码。
2、超过50行以上的方法,可以利用单一原则对方法进行重构。
3、方法的参数建议不超过3个。
4、函数的参数不允许传入布尔类型的然后里面再根据传值来判断。遵循单一原则。
# (5)异常处理
1、所有执行操作数据的必须加异常处理和回滚。
2、finally里面不要写return。
3、方法的返回值可以为 null,必须添加注释充分说明什么情况下会返回 null 值。