• (三) 格式规约

    (三) 格式规约

    1.【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

    • 左大括号前不换行。
    • 左大括号后换行。
    • 右大括号前换行。
    • 右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

    2.【强制】左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。详见第5条下方正例提示。

    3.【强制】if/for/while/switch/do等保留字与左右括号之间都必须加空格。

    4.【强制】任何运算符左右必须加一个空格。

    说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

    5.【强制】缩进采用4个空格，禁止使用tab字符。

    说明：如果使用tab缩进，必须设置1个tab为4个空格。IDEA设置tab为4个空格时，请勿勾选Use tab character；而在eclipse中，必须勾选insert spaces for tabs。

    1. 正例：（涉及1-5点）
    2. public static void main(String args[]) {
    3.     //缩进4个空格
    4.     String say = "hello";
    5.     //运算符的左右必须有一个空格
    6.     int flag = 0;
    7.     //关键词if与括号之间必须有一个空格，括号内的f与左括号，0与右括号不需要空格
    8.     if (flag == 0) {
    9.         System.out.println(say);
    10.     }
    11.     //左大括号前加空格且不换行；左大括号后换行
    12.     if (flag == 1) {
    13.         System.out.println("world");
    14.         //右大括号前换行，右大括号后有else，不用换行
    15.     } else {
    16.         System.out.println("ok");
    17.         //在右大括号后直接结束，则必须换行
    18.     }
    19. }

    6.【强制】单行字符数限制不超过 120个，超出需要换行，换行时遵循如下原则：

    • 第二行相对第一行缩进 4个空格，从第三行开始，不再继续缩进，参考示例。
    • 运算符与下文一起换行。
    • 方法调用的点符号与下文一起换行。
    • 在多个参数超长，逗号后进行换行。
    • 在括号前不要换行，见反例。
      1. 正例：
      2. StringBuffer sb = new StringBuffer();
      3. //超过120个字符的情况下，换行缩进4个空格，并且方法前的点符号一起换行
      4. sb.append("zi").append("xin")...
      5.   .append("huang")...
      6.   .append("huang")...
      7.   .append("huang");
      8. 反例：
      9. StringBuffer sb = new StringBuffer();
      10. //超过120个字符的情况下，不要在括号前换行
      11. sb.append("zi").append("xin")...append
      12.   ("huang");
      13. //参数很多的方法调用可能超过120个字符，不要在逗号前换行
      14. method(args1, args2, args3, ...
      15.   , argsX);
      7.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
      1. 正例：下例中实参的"a",后边必须要有一个空格。
      2. method("a", "b", "c");
      8.【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。
      9.【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。
      1. 正例：
      2. int a = 3;
      3. long b = 4L;
      4. float c = 5F;
      5. StringBuffer sb = new StringBuffer();
      6. 说明：增加sb这个变量，如果需要对齐，则给a、b、c都要增加几个空格，在变量比较多的
      10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

      说明：没有必要插入多行空格进行隔开。