代码排版包括空行,空格,断行和缩进等内容。代码排版内容比较多,工作量也大,也非常重要。
空行
空行用以将逻辑相关的代码段分隔开,以提高可读性。空行使用规范:
-
类声明和接口声明之间保留两个空行
![image]()
-
两个方法之间保留一个空行。
![image]()
-
方法的第一条语句之前保留一个空行。
![image]()
-
代码注释(尾部注释外)之前保留一个空行。
![image]()
-
一个方法的两个逻辑段之间
![image]()
空格
代码中有些位置是需要有空格的。
-
赋值符号=前后各有一个空格:
int YEAR_LENGTH = 4;
int day = super.getDate(); -
所有的二元运算符都应该使用空格与操作数分开:
![image]()
-
一元操作符:负号“-”、自增“++”和自减“--”等,它们与操作数之间没有空格。
![image]()
-
小左括号“(”之后,小右括号“)”之前不应有空格。
a = (a + b) / (c * d) -
大左括号“{”之前有一个空格。示例如下:
![image]()
-
方法参数列表小左括号“(”之前没有空格,小右括号“)”之后有一个空格,参数列表中参数逗
号“,”之后也有一个空格。示例如下:
![image]()
-
关键字之后紧跟着小左括号“(”,关键字之后应该有一个空格。如下示例中while之后有一个空格。
![image]()
缩进
4个空格常被作为缩进排版的一个单位。虽然在开发时程序员使用制表符进行缩进,而默认情况下一个
制表符等于8个空格,但是不同的IDE工具中一个制表符与空格对应个数会有不同。Eclipse中默认是一
个制表符对应4个空格。
缩进可以依据一般规范,如下。
- 在方法、Lambda、控制语句等包含大括号“{}”的代码块中,代码块的内容相对于首行缩进一个级别(4个空格)。
- 如果是if语句中条件表达式的断行,那么新的一行应该相对于上一行缩进两个级别(8个空格),再往后的断行要与第一次的断行对齐。

上述代码第①行和第②行是if语句条件表达式的断行,代码第①行和第②行要对齐。
断行:

其他规范:





本文来自博客园,作者:kevin的ICT菜鸟之路,转载请注明原文链接:https://www.cnblogs.com/kevinwen25/articles/17874757.html










浙公网安备 33010602011771号