简时——beta代码规范

这个作业属于哪个课程	2020春|S班
这个作业要求在哪里	团队作业第六次——beta冲刺+事后诸葛亮
团队名称	TimeMaster
这个作业的目标	进行beta冲刺前的准备
作业正文	简时——beta代码规范
其他参考文献	……

1. 代码规范

1.1 编程规约

1.1.1 命名风格

1.代码命名不以下划线或美元符开头
2.代码命名不以拼音英文混合
3.类名以UpperCamelCase，驼峰命名
4.包名小写
5.变量名、参数名、方法名LowerCamelCase，驼峰命名
6.允许常用单词缩写，但是不建议
7.方法名尽量体现动作意义
8.插入使用add、删除使用delete、更新使用update
9.实现类采用Impl后缀
10.接口模块等采用设计模式可以从命名体现

1.1.2 常量定义

1.不允许出现魔法值
2.long型应采用L表示避免看错

1.1.3 代码格式

1.大括号为空则不换行、其他情况为左括号前不换行后换行、右大括号前换行后换行（else除外）
2.括号旁不加空格（保留字除外）、运算符两侧加上空格
3.缩进采用一个tab
4.代码块必须大括号围住
5.单行最大代码长度120个字符
6.参数传递时逗号后加一个空格

1.1.4 OOP规约

1.访问静态方法通过类名
2.重写方法加上@override
3.避免对象调用的空指针，尽可能使用常量或确有值对象调用方法
4.包装类对象值比较采用equals
5构造方法不要放入业务逻辑
6.同名方法放在一起
7.getter、setter方法不增加业务逻辑

1.1.5 控制语句

1.减少if-else格式嵌套，如果可以直接返回建议直接返回
2.复杂判断不要直接放入判断条件中，可以增加变量保存
3.循环增加性能，避免在循环体内重复的不必要操作

1.1.6 注释

1.类、属性、方法采用/内容/注释
2.内部单行采用//、多行采用/内容/
3.代码与注释修改同步
4.中文注释推荐
5.注释力求节俭

1.2 数据库编码规约

1.2.1 建表规约

1.表名字段名小写、避免出现数字和复数、谨慎字段名
2.字段尽量表达数据意义
3.禁止使用保留字
4.允许适当冗余（操作较少字段）
5.内容太大时建议单独建表，提高查询效率
6.每张表为主键自增id

1.2.2 SQL语句

1.使用官方推荐的count（*）形式，不适用count（字段）
2.查询数据量大时使用分页查询、当总数查询为0时，立即返回结果
3.不使用过程
4.不使用拼接SQL语句