阿里巴巴 JAVA 开发手册-编程规约-格式规约

来源:互联网 发布:北京地铁软件 编辑:程序博客网 时间:2024/05/21 17:16
  1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:
    1) 左大括号前不换行。
    2) 左大括号后换行。
    3) 右大括号前换行。
    4) 右大括号后还有 else 等代码则不换行;表示终止右大括号后必须换行。
  2. 【强制】 左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空
    格。详见第 5 条下方正例提示。
  3. 【强制】if/for/while/switch/do 等保留字与左右括号之间都必须加空格。
  4. 【强制】任何运算符左右必须加一个空格。
    说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。
  5. 【强制】代码块缩进 4 个空格,如果使用 tab 缩进,请设置成 1 个 tab 为 4 个空格。
  6. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时,遵循如下原则:
    1) 换行时相对上一行缩进 4 个空格。
    2) 运算符与下文一起换行。
    3) 方法调用的点符号与下文一起换行。
    4) 在多个参数超长,逗号后进行换行。
    5) 在括号前不要换行,见反例。
  7. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。
    正例:下例中实参的”a”,后边必须要有一个空格。
    method(“a”, “b”, “c”);
  8. 【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。
    正例:
    int a = 3;
    long b = 4L;
    float c = 5F;
    StringBuffer sb = new StringBuffer();
    说明:增加 sb 这个变量,如果需要对齐,则给 a、b、c 都要增加几个空格,在变量比较多的情况下,是一种累赘的事情。
  9. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用 windows 格式。
  10. .【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
    说明:没有必要插入多行空格进行隔开。
1 0
原创粉丝点击