一、编程规约 （一）命名风格
- 通用规则 ：所有编程相关的命名均不能以下划线或美元符号开始或结束，严禁使用拼音与英文混合的方式，更不允许直接使用中文，且要避免使用任何人类语言中的种族歧视性或侮辱性词语。
- 类名 ：使用 UpperCamelCase 风格，例外情况如 DO/PO/DTO/BO/VO/UID/AO 等 。
- 方法名、参数名、成员变量、局部变量 ：统一使用 lowerCamelCase 风格 。
- 常量 ：命名全部大写，单词间用下划线隔开，力求语义表达完整清楚 。
- 特殊类命名 ：抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以要测试的类的名称开始，以 Test 结尾。
- 数组定义 ：类型与中括号紧挨相连来定义数组。
- 布尔类型变量 ：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
- 包名 ：统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，统一使用单数形式。但类名如果有复数含义，可以使用复数形式。 （二）项目与目录命名
- 项目与目录 ：全部采用小写方式，项目名称用下划线分隔，子模块名称用中划线分隔；包命名、虚拟目录、资源路径命名使用英文小写，通常为一个单词，若多个单词则用下划线分隔。
二、代码设计原则
参考 Kent Beck 的简单设计四原则：
- 通过所有测试 ：强调外部需求，这是代码实现最重要的。
- 尽可能消除重复 ：保证代码的模块架构正交，更容易修改。
- 尽可能清晰表达 ：确保代码具有良好的可阅读性。
- 更少代码元素 ：保证代码简洁，在简洁和表达力之间更看重表达力。
三、注释规范
- 类（抽象类）、类属性、类方法的注释必须使用 JavaDoc 规范，即 /** 内容 */ 格式，不得使用 // xxx 方式。
- 注释的双斜线与注释内容之间有且仅有一个空格。
- TODO/TBD 注释一般用来描述已知待改进、待补充的修改点，格式如 // TODO : 补充XX处理 。
四、代码格式规范
- 括号代码要求，括号中间的操作变量要有空格，左右括号不出现空格。
- 行字符数限制不超过 120 个，超出需要换行，换行时遵循相应原则 。
- 方法传参中，多个参数之间要有空格。
五、方法参数规范
无论是 controller、service、dao 还是其他代码，每个方法最多 3 个参数，超出 3 个参数要封装成 JavaBean 对象。
