Java 编码规范3(编程规约-代码格式)

代码格式

---

其它相关文章
Java 编码规范1(编程规约-命名风格)
Java 编码规范2(编程规约-常量定义)
Java 编码规范3(编程规约-代码格式)
Java 编码规范4(编程规约-OOP规约)
Java 编码规范5(编程规约-集合处理)
Java 编码规范6(编程规约-并发处理)
Java 编码规范7(编程规约-控制语句)
Java 编码规范8(编程规约-注释规约与其它)
Java 编码规范9(异常日志)
Java 编码规范10(单元测试)
Java 编码规范11(安全规约)
Java 编码规范12(MySQL-建表规约)
Java 编码规范13(MySQL-索引规约)
Java 编码规范14(MySQL-SQL语句与ORM映射)
Java 编码规范15(工程结构)

---

1. [强制] 大括号的使用约定。
   
   • 如果是大括号内为空，则简洁地写成{}即可，不需要换行；
   • 如果是非空代码块则：
     
     • 左大括号前不换行。//==其它的都是异端，通通乱棍拖出去。==
     • 左大括号后换行。
     • 右大括号前换行。
     • 右大括号后还有else等代码则不换行；表示终止的右大括号后必须换行。
2. [强制] 左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。详见第5条下方正例提示。
   
   • 反例：if ([空格]a == b[空格])
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-6点）

     // 请注意所有注释，在双斜线之后有一个空格
     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. [强制] 注释的双斜线与内容之间有且仅一个空格。

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

   • 第二行相对一缩进 4个空格，从第三行开始不再继续缩进参考示例。
   • 运算符与下文一起换行。
   • 方法调用的点符号与下文一起换行。
   • 方法调用时，多个参数，需要换行时，在逗号后进行。
   • 在括号前不要换行，见反例。

   • 正例:

     StringBuffer sb = new StringBuffer();
     // 超过120个字符的情况下，换行缩进4个空格，点号和方法名称一起换行
     sb.append("zi").append("xin")...
         .append("huang")...
         .append("huang")...
         .append("huang");

   • 反例:

     StringBuffer sb = new StringBuffer();
     // 超过120个字符的情况下，不要在括号前换行
     sb.append("zi").append("xin")...append
         ("huang");
     // 参数很多的方法调用可能超过120个字符，不要在逗号前换行
     method(args1, args2, args3, ...
         , argsX);

8. [强制] 方法参数在定义和传入时，多个参数逗号后边必须加空格。

   • 正例：下例中实参的”a”,后边必须要有一个空格。

     method("a", "b", "c");

9. [强制] IDE的text file encoding设置为UTF-8; IDE中,文件的换行符使用Unix格式，不要使用Windows格式。

10. [推荐] 没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。

    • 正例：

      int a = 3;
      long b = 4L;
      float c = 5F;
      StringBuffer sb = new StringBuffer();

11. [推荐] 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

    • 没有必要插入多个空行进行隔开。