码出高效——小组代码规范
编程规约
一.命名风格
- 1.代码中的命名不能以下划线、美元符号开头或结尾。
反例：_name/$name/name&/name_
- 2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式 也要避免采用。
正例：name/age/address等国际通用的可以使用。
反例：mingzi/getNiJi()/dizhi等不可使用。
- 3.【强制】类名使用 UpperCamelCase 风格，即首字母大写。
正例：MyBase/ViewPager/ViewPagerAdpter
反例：mybase/viewpager/viewpageradpter
- 4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式。
正例：myBase/getMessage()/viewPager\
- 5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
- 6.【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类 命名以它要测试的类的名称开始，以 Test 结尾。
正例：AbstractAnimals/NotfoundException
- 7.【强制】类型与中括号紧挨相连来表示数组。
正例：定义整形数组 int[] arrayDemo;
反例：在 main 参数中，使用 String args[]来定义。
- 8.【参考】各层命名规约：\
- 获取单个对象的方法用 get 做前缀。
- 获取多个对象的方法用 list做前缀，复数形式结尾如：listObjects。
- 获取统计值的方法用 count 做前缀。
- 插入的方法用 save/insert 做前缀。
- 删除的方法用 remove/delete 做前缀。
- 修改的方法用 update 做前缀。
二.常量定义
- 1.【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
- 2.【强制】在 long 或者 Long 赋值时，数值后使用大写的
L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。 说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?
三.代码格式
- 1.【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果 是非空代码块则：\
- 左大括号前不换行。
- 左大括号后换行。
- 右大括号前换行。
- 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
- 2.【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
- 3.【强制】注释的双斜线与注释内容之间有且仅有一个空格。
- 4.【强制】任何二目、三目运算符之间必须加一个空格。
- 5.采用四个空格缩进、严谨使用tab键缩进！
举例：
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左大括号前加空格且不换行；左大括号后换行
if (flag == 1) {
System.out.println("world");
// 右大括号前换行，右大括号后有 else，不用换行
} else {
System.out.println("ok");
// 在右大括号后直接结束，则必须换行
}
}
6.【强制】注释的双斜线与注释内容之间有且仅有一个空格。
// 这是示例注释，请注意在双斜线之后有一个空格 String ygb = new String();
7.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
// 下例中实参的 args1，后边必须要有一个空格。 method(args1, args2, args3);
8.【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
// 反例： int aa = 1; int bb = 2; int c = 3;// 没必要为了等号对齐而多添加空格。
四.控制语句
- 1.【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程 序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且 放在最后，即使空代码。
- 2.【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用 单行的编码方式：if (condition) statements;
五.注释语句
- 1.【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用 // xxx 方式。
- 2.【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、 异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
- 3.【强制】所有的类都必须添加创建者和创建日期。
安全规则
- 【强制】用户敏感数据禁止直接展示
例一：中国大陆个人手机号码显示为:158****9119，隐藏中间 4 位，防止隐私泄露。
例二：密码不能被看到,例如********。
参考资料
本文参考《阿里巴巴java开发手册》
