峡谷partners——团队作业五:代码规范、α冲刺任务与计划
目录
作业基本信息
| 这个作业属于哪个课程 | 2021春软件工程实践S班(福州大学) |
|---|---|
| 这个作业要求在哪里 | 团队作业五——站立式会议+alpha冲刺 |
| 团队名称 | 峡谷partners |
| 这个作业的目标 | 明确并制定团队的代码规范和本次冲刺任务与计划 |
| 其他参考文献 | 阿里巴巴Java开发手册终极版v1.3.0 , 华为内部代码规范 |
团队代码规范
1.排版
- 缩进大小为4个字符
- 用空行区分程序块，变量说明后需要空行
- 函数之间用空行隔开
- 每行最多字符数为80，较长须分行写
- if、else、while等语句自占一行，必须带{}
- 操作符前后空格
2.注释
- 风格尽量统一，使用"/* ... */"
- 对变量的定义和分支语句进行注释
- 在每一个程序块的头部添加注释，解释功能
- 数据结构声明需注释
- 注释中尽量避免缩写
- 修改代码的同时修改注释，保证一致性
- 函数头部注释，标明参数、功能、返回值
3.命名
- 应尽量简洁
- 标识符作用域与其长度成正比，使用长名称时最好加上注解
- 常量名全部大写
- 变量命名采用lowerCamelCase风格，尽量避免当缩写，避免单个字符命名
- 类、函数的命名规则为UpperCamelCase风格
- 全局变量和局部变量不同名
4.前后端规约
- 前后端交互的 API，需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体
5.异常规约
- 异常信息必须包括异常码和异常说明
- 如果函数可能返回null，需要在注释中说明什么情况下回返回null
6.安全规约
- 对邮件、下单、电话、支付等敏感数据，必须实现防重放机制
7.单元测试规约
- 单元测试必须使用assert判断结果
- 单元测试必须具有可重复性，不能依赖外部条件
8.其他规则
- 对SQL语句的使用需要注释
冲刺任务及计划
冲刺任务
| 任务 | 内容 |
|---|---|
| UI | 登录，注册，选择模式，选关，匹配，设置 操作按钮，暂停按钮，计时器，通关，失败 |
| 客户端 | 障碍物类:地刺，冰面，轨道，地雷，掉刺，滚石 游戏管理类:萝卜数量，时间，死亡次数 角色控制，相机跟随，角色数据 其他：萝卜，过关传送门 |
| 动画 | 角色操控，爆炸 |
| 其他 | 博客、PPT、关卡设计、角色模型 |
冲刺计划
