文章通过学习《阿里巴巴Java开发手册》整理。
大括号的使用约定
如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则
左大括号前不换行,后换行;
右大括号前换行;
右大括号后还有else等代码则不换行;
表示终止的右大括号后必须换行。
小括号使用约定
左小括号和字符之间不出现空格
右小括号和字符之间不出现空格。反例:if (空格
a == b空格
)
保留字与括号之间
if/for/while/switch/do等保留字与括号之间都必须加空格。
运算符
任何二目、三目运算符的左右两边都需要加一个空格。
说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
缩进
采用4个空格缩进,禁止使用tab字符。
如果使用tab缩进,必须设置1个tab为4个空格。
IDEA设置tab为4个空格时,不要勾选Use tab character
;而在eclipse中,必须勾选insert spaces for tabs
.
正例:(涉及到前面介绍的几点)
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");
//在右大括号后直接结束,则必须换内行
}
}
注释
注释的双斜线与注释内容之间有且仅有一个空格。
字符数限制
单行字符数限制不超过120个,超出需要换行,换行时遵循如下原则:
- 第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进;
- 运算符与下文一起换行;
- 方法调用的点符号与下文一起换行;
- 方法调用时多个参数,需要换行时,在逗号后进行;
- 在括号前不要换行。
正例:
StringBuffer sb = new StringBuffer();
//超过120个字符的情况下,换行缩进4个空格,点号和方法名称一起换行
sb.append("you").append(" are")
.append(" a")
.append(" confident people.")
参数
方法参数在定义和传入时,多个参数逗号后边必须加空格。
正例:method("a", "b", "c")
编码格式
IDE的text file encoding设置为UTF-8;IDE中文件的换行符使用Unix格式,不要使用Windows格式。