2017-2018-1 JAVA实验站 第六、七周作业
本周作业要求
2017-2018-1 团队六七周作业要求，详情请见此处
JAVA实验站团队作业
需求规格说明书
JAVA 实验站 《需求规格说明书》初始版
JAVA 实验站 《需求规格说明书》改进版
初始版不足之处：
1、文字和图片的排版
2、语言表达
改进的内容主要有：
1、文字和图片的排版（包括字体和字号以及页面布局）
2、跟据策划书，添加修改了一部分内容
3、优化了一些语言的表述，使之更加规范严谨
代码规范和编码原则
4.1代码规范
人与人之间可以通过语言和文字沟通，但是对于计算机来说，是不能正常识别人类的不同的语言习惯以及不同的文字的。因此，必然要制定统一标准，来让机器正确理解你的意思。同时，代码也应具有可阅读性，能够让你的同伴正常阅读，这就产生了代码规范。
代码规范分为两个部分：代码风格规范和代码设计规范
4.2代码风格规范
- 1．原则：简洁易读无二义性
- 2．缩进：4个空格
- 3．行宽：100字符
- 4．使用括号
- 5．{}用于单独的一行
- 6．不要把多个语句或多个变量放在一行
- 7．命名不要提到类型或其他语法如：arraylistofholidays，避免过多的描述，避免不必要的修饰词
- 8．下划线分割变量名中作用域和变量的语义
- 9．变量名大小写区分
- 10．区分必要注释和非必要注释
4.3代码设计规范
- 1．函数最好有单一的出口
- 2．所有的参数都要检验正确性
4.4代码复审
正确定义：看代码是否在代码规范的框架内正确的解决了问题。
最有效手段为同伴复审。
代码复审的目的：
- 1.找出代码错误
- 2.发现逻辑错误
- 3.发现算法错误
- 4.发现潜在的错误和回归性错误
- 5.发现可能需要改进的地方
- 6.让更多的同伴熟悉项目各部分代码
4.4.1
代码即使完美，代码复审也有“教育”和“传播知识”的作用。可以有助于团队成员相互了解。
新成员可以在实践中学习。
4.4.2代码复审的步骤
- 1.必须成功编译
- 2.必须测试过代码（单步跟踪）
- 3.程序员必须提供新的代码，以及文件差异分析工具
- 4.在面对面的复审中，开发者讲述修改的前因后果，复审者可以随时打断，提出意见
- 5.复审者必须逐一提供反馈意见
- 6.开发者必须解决所有问题
- 7.复审结果双方必须意见一致，好的复审者考虑深远
4.4.3代码复审的核查表
- 1.概要：成员加入自己认为重要的部分
- 2.设计规范部分
- 3.代码规范部分
- 4.具体代码部分
- 5.效能
- 6.可读性
- 7.可测试性
4.5结对编程
结对编程可以时刻进行代码复审，提高效率。
数据库设计与ER图
后端架构设计
确定团队分工
分工要求请参考此篇博客
组员在上述任务中的分工和工作量比例
| 姓名 | 分工 | 用时 | 完成情况 |
|---|---|---|---|
| 张泰毓 | 后端架构设计 | 小时 | % |
| 石亚鑫 | 代码规范和编码原则 | 小时 | % |
| 张浩林 | 后端架构设计 | 小时 | % |
| 张韵琪 | 博客+改进版需求策划案markdown编写 | 小时 | % |
| 王彪 | 将各个叶子结点的功能加入，并确定每个子功能的工作量 | 小时 | % |
| 齐力锋 | 修改完善上周提交的需求规格说明书、燃尽图 | 小时 | % |