codestyle.md

Noobhui的代码风格

缩进

• 缩进使用用4个空格而不是tab

变量命名

1. 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
2. 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
3. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
4. 中括号是数组类型的一部分，数组定义如下：String[] args。

每行最多字符数

• 单行字符数限制不超过120个，超出需要换行。

函数最大行数

• 单个函数限制不超过120行。

函数、类命名

1. 类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO等。
2. 抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
3. 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
4. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

常量

1. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚。
2. 不允许出现未经定义的常量直接出现在代码中。
3. long或者Long初始赋值时，必须使用大写的L。

空行规则

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

注释规则

1. 类、类属性、类方法的注释必须使用Javadoc规范，使用/*内容格式，不得使用//内容格式。
2. 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/*注释。

操作符前后空格

1. 方法参数在定义和传入时，多个参数逗号后边必须加空格。
2. 左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。
3. if/for/while/switch/do等保留字与左右括号之间都必须加空格。
4. 任何运算符左右必须加一个空格。

其他规则

代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。