软件工程-团队作业三
一、代码风格规范
主要是文字上的规定,看似表面文章,实际上非常重要。
代码风格的原则是:简明,易读,无二异性。
1.1缩进
Tab键在不同的情况下会显示不同的长度,严重干扰阅读体验,4个空格的距离从可读性来说正好。
1.2行宽
现代行宽限定为100字符。
1.3括号
在复杂的条件表达式中,用括号清楚的表示逻辑优先级。
1.4断行与空白的{}行
如:if(condition){
DoSomething();
}
else{
DoSomethingElse();
}
1.5分行
不要把多条语句放在一行,严格的说,不要把多个变量定义在一行上。
1.6命名
- 在变量名中不提到类型或其他语法方面的描述。
- 避免过多的描述。
- 如果信息可以从上下文中得到,那么此类信息不必写在变量名中。
- 避免可要可不要的修饰词。
1.7下划线
下划线用来分隔变量名字中的作用域标注和变量的语义,如:一个类型的成员变量通常用m_来表示,或者简单地用一个下划线来做前缀。
1.8大小写
由多个单词组成的变量名,如果全部是小写,很不易读,一个简单的解决方案就是用大小写区分。
1.9注释
1. 注释要简单明了
2. 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
3. 在必要的地方注释,注释量要适中。注释的内容要清楚,明了,含义准确,防止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。
4. 对代码的注释应放在其上方相邻位置,不可放在下面。
5. 对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;同一结构中不同域的注释要对齐。
6. 变量、常量的注释应放在其上方相邻位置或右方。
7. 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
二、 代码设计规范
牵涉到程序设计、模块之间的联系、设计模式等方方面面的通用原则。
2.1函数
最重要的一条原则就是:只做一件事,并且要做好。
2.2 goto
函数最好有单一的出口,为了达到这一目的,可以使用goto。
2.3 错误处理
当程序的主要功能实现后,一些程序员会乐观地估计只需要另外20%的时间,给代码加一些错误处理就大功告成了,但是这20%的工作往往需要全部项目80%的时间。
三、项目E-R图
四、项目功能流程
(1)开始游戏界面->点击开始游戏->进入游戏
(2)在游戏界面,屏幕下方有三个按钮,石头剪刀布,敌方出拳从上往下随机出来,玩家有三次出错机会,三次出错游戏结束,界面会跳到再来一次
(3)重新开始游戏界面->点击再来一次->回到开始游戏界面
五.主要分工及贡献分
姓名 | 分工 | 贡献分 |
易杰 | 主要负责游戏开发 | 10 |
马燕 | 主要负责游戏界面美化 | 10 |
苏航 | 主要负责游戏调试 | 10 |
赵海瑞 | 主要负责游戏调试 | 10 |