Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.45 KB

codestyle.md

File metadata and controls

39 lines (30 loc) · 1.45 KB

缩进

使用tab缩进,设置1个tab为4个空格。 (取消勾选use tab character,indent设置为4)

变量命名

1、不使用拼音和中文进行变量命名。
2、变量命名使用lowerCamelCase风格。
3、缩写规范化,避免望文不知义。

每行最多字符数

单行字符数限制不超过 120个,超出需要换行。(第二行相对第一行缩进4个空格,之后行不再继续缩进)

函数最大行数

函数的行数尽可能控制在50行以内。

函数、类命名

1、函数名使用lowerCamelCase风格。
2、类名使用UpperCamelCase风格。
3、测试类命名以它要测试的类的名称开始,以Test结尾。

常量

由大写字母和下划线组成,”_“作为单词分隔符。

空行规则

1、相同业务逻辑和语义之间不插入空行。
2、不插入多行空格进行隔开。

注释规则

1、类、类属性、类方法的注释使用Javadoc规范。
2、所有的类注释时添加创建者信息。
3、方法内部用//单行注释,在被注释语句上方另起一行。
4、方法内部多行注释,与代码对齐。

操作符前后空格

任何运算符左右必须加一个空格。

其他规则

1、文件编码设置为UTF-8,换行符使用Unix格式。
2、使用正则表达式时利用预编译功能,加快正则匹配速度。
private static final Pattern pattern = Pattern.compile(regexRule);