codestyle.md

参照自《码出高效_阿里巴巴Java开发手册》

缩进

• 缩进采用4个空格。

变量命名

• 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
• 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
• 参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
• 杜绝完全不规范的缩写，避免望文不知义。

每行最多字符数

• 单行字符数限制不超过 120个，超出需要换行，换行时遵循如下原则：

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

函数最大行数

• 函数最大行数不要超过100行。

函数、类命名

• 方法名使用lowerCamelCase风格，必须遵从驼峰形式。
• 类名使用UpperCamelCase风格，必须遵从驼峰形式。

常量

• 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

空行规则

• 大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

• 方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

注释规则

• 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
• 与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

空格

• if/for/while/switch/do等保留字与左右括号之间都必须加空格。
• 任何运算符左右必须加一个空格。
• 方法参数在定义和传入时，多个参数逗号后边必须加空格。

其他规则

• 多个不同的运算符同时存在时合理使用括号来明确优先级。
• 在使用正则表达式时，利用好其预编译功能有效加快正则匹配速度。

说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);