代码规范
命名风格
- 1.强制代码中命名均不能以下划线或美元符号开始以及结束
- 2.强制代码中命名严禁使用拼音与英文混合，更加不行直接使用中文的方式
- 3.强制类名使用 UpperCamelCase 风格，必须遵守驼峰形式
- 4.强制方法名，参数名，成员变量，局部变量都统一使用 lowerCamelCase 风格，必须遵守驼峰形式
- 5.强制常量命名全部大写，单词间用下划线隔开
- 6.强制 model 中布尔类型的变量，都不要加 is 开头
- 7.强制包名统一使用小写，点分隔符之前有且仅有一个英语单词
- 8.server 层命名规约
获取单个对象的方法用 get 做前缀 获取多个对象的方法用 list 做前缀 获取统计的方法用 count 做前缀 插入方法用 save 或 insert 做前缀 删除方法用 remove 或 delete 做前缀 修改方法用 update 做前缀
常量命名
强制不允许任何魔法值直接出现在代码中(即未定义的常量)
代码格式
- 1.强制大括号使用约定
- 2.强制左右小括号和字符之间不允许出现空格
- 3.强制任何二目三目运算符的左右两边都需要加空格
- 4.强制缩进采用 4 个空格，禁止使用 tab 字符
- 5.强制单行字符限制超出 120 个需换行
第二行相对第一行缩进 4 个空格，第三行开始不在缩进 运算符与下文一起换行 方法调用的点符号与下午一起换行 在多个参数超长，在逗号后换行 在括号钱不要换行
- 6.强制方法参数在定义和传入是，多个参数逗号后必须加空格
日志规约
强制应用中使用日志框架 SLFJ 中的 API