编程规约
(三)代码格式
- 【强制项目】如果大括号内为空,则简洁的写成{},大括号中间需要换行和空格
非控代码块
1)左边大括号前面不换行
2)左边大括号后换行
3)右边大括号前换行
4)右边大括号后还有else等代码则不换行;表示种植的右边大括号后必须换行 - 【强制项目】左边小括号和字符之间不出现空格
右边小括号和字符之间不出现空格
左边大括号前需要空格
反例:if(空格 a == b 空格) - 【强制项目】if/for/while/switch/do 等保留字与括号之间必须加空格
- 【强制项目】任何二目,三目运算符的左右两边都需要加一个空格
链接: 一目二目三目运算符. - 【强制项目】采用 4 个空格缩进,禁止使用tab字符
如果使用tab必须设置1个tab为一个空格 idea设置tab为4个空格时,请勿勾选Usetab character
1-5点的例子
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");
// 在右大括号后直接结束,则必须换行
}
}
- 【强制项目】注释的双斜线与注释内容之间有且仅有一个空格
例子:// 这是注释 - 【强制项目】在进行类型强制转换的时候,右括号与强制转换值之间不需要任何空格隔开。
例子:int second =(int)first+2; - 【强制项目】单行字符数限制不超过 120个,超出需要换行,换行遵循如下规则
1)第二行相对第一行缩进一个空格,从第三行开始不在继续缩进
2)运算符与下文一起换行
3)方法调用的点傅号与下文一起换行
4) 方法调用中的多个参数需要换行时,在逗号后面进行。
5)在括号前不要换行。
正例:StringBuilder sb = new String Builder();
// 超过120字符的情况下,换行缩进四个空格,点号和方法名称一起换行
sb.sppend(“jack”).append(“Ma”)
.append(“alibaba”)
.append(“alibaba”)
.append(“alibaba”) - 【强制项目】方法参数在定义和传入时,多个参数都好后面必须加空格
例子:method(args1, args2, args3); - 【强制项目】IDE的text file encoding 设置为 UTF-8; IDE中文间的换行符使用Unix格式,不要使用windows格式
- 【推荐项目】单个方法的总行数不要超过80行
- 【推荐项目】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐
- 【推荐项目】不同逻辑,不同语义,不同的业务代码之间插入一个空行分隔开来,以提高可读性
任何情况,没有必要插入多个空行进行隔开