阿里巴巴Java开发手册学习小结2-格式规约

来源:互联网 发布:手机淘宝实名认证开店 编辑:程序博客网 时间:2024/06/07 00:26

本次学习 来源 阿里巴巴Java开发手册 ,文档更新时间2016.12.7 是阿里巴巴集团技术部 首次向Java业界公开,如果有需要开发手册源文档的,欢迎联系
说明 关于 编程规范中的空格 等格式规约 个人觉得 大部分 都是废话,直接使用格式化代码即可,其他可参考。

编程规范

格式规约

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

  • 1,左大括号前不换行
  • 2,左大括号后换行
  • 3,右大括号前换行
  • 4,右大括号后 还有else 等代码则不换行,表示终止右大括号后必须换行

2,【强制】左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空格

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

4.【强制】任何运算符左右必须加一个空格。
说明:运算符 包括赋值运算符= 逻辑运算符,加减乘除符号,三目运算符

5.【强制】代码块缩进4个空格,如果使用table 缩进,则请设置成1个Tab 为4个空格。

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

  • 1) 换行时相对上一行缩进4个空格。
  • 2) 运算符与下文一起换行。
  • 3) 方法调用的点符号与下文一起换行。
  • 4) 在多个参数超长,逗号后进行换行。
  • 5) 在括号前不要换行,见反例。
正例: StringBuffer sb = new StringBuffer(); //超过120个字符的情况下,换行缩进4个空格,并且方法前的点符号一起换行 sb.append("zi").append("xin")… 反例: StringBuffer sb = new StringBuffer(); //超过120个字符的情况下,不要在括号前换行 sb.append("zi").append("xin")…append ("huang"); //参数很多的方法调用也超过120个字符,逗号后才是换行处 method(args1, args2, args3, ... , argsX);

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.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
说明:没有必要插入多行空格进行隔开。

原创粉丝点击