阿里开发手册之代码格式

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_38005943/article/details/81975804

常量定义

1.不允许任务魔法值(即未经预先定义的常量)直接出现在代码中(如String s = new String("hello")>>String s = new String(xxxUtils.HELLO))
2.在long或者long赋值时,数值后使用大写的L,不可以用小写l;(原因是l很容易和1混淆,可读性差)
3.不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护
4.如果变量值仅在一个固定范围内变化用enum类型来定义

代码格式

大括号使用约定.如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:
1.左大括号前不换行.
2.左大括号后换行.
3.右大括号前换行
4.右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行

左小括号和字符之间不出现空格;同样 右小括号和字符之间也不出现空格;而左大括号前需要空格

if/for/while/switch/do等保留字与括号之间必须加空格.

任何二目,三目运算符的左右两边都需要加一个空格(= && || +-*/等   !为一目 ++也是一目)

采用4个空格缩进,禁止使用tab字符(eclipse用tab 必须设置1个tab为4个空格)

注释的双斜线和注释内容之间有且仅有一个空格

单行字符数限制不超过120个,超出需要换行,换行时遵循以下原则:
1.第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进
2.运算符与下文一起换行
3.方法调用的点符号与下文一起换行.
4.方法调用中的多个参数需要换行时,在逗号后进行
5.括号前不要换行,见反例

方法参数在定义和传入时,多个参数逗号后边必须加空格 method(arg1, arg2, arg3)

IDE的text file encoding 设置为UTF-8;IDE中文件的换行符使用Unix格式,不用使用Windows格式

单个方法的总行数不超过80行
    代码逻辑分清红花和绿叶,个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护

不同逻辑,不同语义,不同业务的代码之间插入一个空行分隔开来以提升可读性.(任何情形,没有必要插入多个空行进行隔开)

猜你喜欢

转载自blog.csdn.net/qq_38005943/article/details/81975804