| 这个作业属于哪个课程 | 2020春-S班(福州大学) |
|---|---|
| 这个作业的要求在那里 | 团队作业第五次——站立式会议+alpha冲刺 |
| 团队名称 | Hail Hydra(九头蛇) |
| 这个作业的目标 | 制定团队的代码规范、冲刺任务计划 |
| 作业正文 | 作业正文 |
| 其他参考文献 |
代码规范
命名风格
（1）代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / _name / $Object / name / name$ / Object$
（2）代码中的命名严禁使用拼音与英文混合的方式，不允许直接使用中文的方式
（3）类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外
例：对model类封装的视图对象最后可以VO结尾，例：QuestionVO
（4）方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
（5）常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长
（6）接口的实现类命名格式为：接口名+Imlp
例：QuestionServiceImpl(问题业务层接口实现类)
（7）实体类类名与数据库表对应，表中的下划线命名格式替换成驼峰命名格式
常量定义
（1）不允许任何魔法值（即未经定义的常量）直接出现在代码中
（2）long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。
（3）不使用一个常量类维护所有常量，按常量功能进行归类，分开维护，统一放在项目util包下进行管理
代码格式
（1）大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
①左大括号前不换行。
②左大括号后换行。
③右大括号前换行。
④右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
⑤左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
反例：if (空格 a == b 空格)
⑥单行字符数限制不超过 120 个，超出需要换行
OOP规约
（1）避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
（2）所有的覆写方法，必须加@Override 注解。
（3）不能使用过时的类或方法。
（4）Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
其他要求
（1）后端实现不同层次类时应避免跨层访问（Controller不调用dao层代码），避免底层方法调用高层方法
（2）前后端编码统一使用UTF-8格式
冲刺任务与计划
第一阶段（4月30日前）
本阶段的任务是实现项目的基本功能，大体安排如下：
- 前端前台页面：完成问题详情页面，完成与后端接口的数据交互
- 前端后台页面：完成后台所有界面和与后端接口交互的数据交互（批量增加用户和导出奖励申请名单功能除外）
- 后端：实现基本功能所需的接口
- 文档：分类整理项目已有的文档，并上传至仓库保存
注：因为我们在前面有完成部分编码工作，所以该部分没有留很长时间
第二阶段（5月1日—5月2日）
本阶段的主要任务是对第一阶段完成的工作进行测试，大体安排如下
- 前端人员：对界面进行检查，查看是否数据有按预期显示，所有跳转是否正常
- 后端人员：对已实现功能进行单元测试和记录
- 测试人员：完成对接口的测试和记录工作
- 文档人员：完成对文档的汇总和整理，上传至仓库
第三阶段（5月3日—5月6日）
本阶段主要任务是对项目一些非功能性需求进行完成，大体安排如下：
- 前端前台界面：完成对输入的人性化提示功能，完成对传输数据的加密工作
- 前端后台界面：完成批量增加用户，导出奖励申请名单功能
- 后端：完成对访问请求的权限验证，对数据的加密处理
第四阶段（5月7日—5月9日）
本阶段主要是对项目进行测试和文档的完成，前后端完善前面没完成的工作，准备答辩