一、规约目的
1.规约目的
(1)减少维护成本
几乎没有任何一个软件,在整个生命周期过程中,均由最初的开发人员来维护
(2)提高合作效率
(3)提高自身开发能力,减少bug
(4)改善软件的可读性
二、命名规约
- 代码中的变量命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
- 代码中不允许使用中文拼音。
- 类名尽量使用UpperCamelCase风格,即首字母要大写,其他字母小写,特殊类除外,如PO、DAO等。
- 方法名、参数名、成员变量、局部变量等统一采用lowerCamelCase风格,驼峰形式。
- 常量命名要全部大写,单词间用下划线隔开。
- 抽象类命名使用Abstract或Base开头,异常类的命名使用Exception结尾,测试类命名以它要测试的类名开始,以Test结尾。
- 类型与中括号之间无空格相连定义数组。例:int[] arrayDemo;
- POJO类的boolean类型的变量前不要加is前缀,否则部分框架会解析错误。例:属性为isDeleted 它的方法也为isDeleted(),框架会去找Deleted属性,找不到就会报错。
- 定义包名统一用小写,单数,类名可以使用复数:例 Utils 类。
- 杜绝完全不规范的缩写,避免词不达意。
三、代码规约
- 大括号的使用约定。如果大括号内为空,