【Java编程规范】 代码格式篇

  • 【强制】采用4个空格缩进,禁止使用tab字符。
    说明:
    如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。 IDEA 设置 tab 为 4 个空格时,
    请勿勾选 Use tab character ;而在 eclipse 中,必须勾选 insert spaces for tabs 。
    upload successful

  • 【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式,不要使用Windows格式。
    upload successful
    upload successful

  • 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时 遵循如下原则:

    • 1) 第二行相对第一行缩进 4 个空格;
    • 2) 运算符与下文一起换行;
    • 3) 方法调用的点符号与下文一起换行;
    • 4) 方法调用中的多个参数需要换行时,在逗号后进行;
    • 5) 在括号前不要换行。 正例:

      StringBuffer sb = new StringBuffer();
      // 超过120个字符的情况下,换行缩进4个空格,点号和方法名称一起换行
      
      sb.append("zi").append("xin")...
      1
      2
      3
      4
      5
      6
      7
                   .append("huang")...
      .append("huang")...
      .append("huang");
      ```<br>
      * 6) 不要在逗号前换行
      ```java method(args1, args2, args3, ..
      , argsX);
      <br>
    • 7) 分割原则
      • 在逗号后面分割;
      • 在操作符前分割。
  • 【推荐】单个方法的总行数不超过 80 行。
    说明: 包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总。代码逻辑分清红花和绿叶,个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护。

  • 成员与类或者接口包池2个空行,包括注释
    public class zszxz {

    // 成员与类或者接口包池2个空行,包括注释;
    private String love;

  • 数组初始化:可写成块状结构

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    new int[] {
    0, 1, 2, 3
    }

    new int[] {
    0,
    1,
    2,
    3
    }

    new int[] {
    0, 1,
    2, 3
    }