软件工程（2019）第一次结对作业
- 审查人以及代码信息
（1）结对人：张斯豪
（2）项目代码地址：代码地址
（3）项目代码功能：游戏
- 审查代码细节汇总
按照C++代码审查表审查汇总如下
| 功能模块名称 | 简单的游戏框架 | ||
| 审查人 | 高钰清 | 审查日期 | 2019年4月25日 |
| 代码名称 | 游戏框架 | 代码作者 | 张斯豪 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 是 | ||
| 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 版权和版本声明是否完整？ | 是 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 否 | |
| 头文件中是否只存放“声明”而不存放“定义” | 否 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 是 | ||
| 代码行内的空格是否得体？ | 是 | ||
| 长行拆分是否得体？ | 是 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 否 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 是 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | |
| 标识符是否直观且可以拼读？ | 是 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ | 是 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 无复杂运算符 | |
| 是否编写太复杂或者多用途的复合表达式？ | 否 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | 否 | |
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 无布尔变量 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判 | 是 | ||
| 断移到循环体的外面？ | |||
| 重要 | Case语句的结尾是否忘了加break？ | 无Case语句 | |
| 重要 | 是否忘记写switch的default分支？ | 无switch | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无goto语句 | |
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 是 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 | |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 否 | ||
| 生存期内是常量，而对于整个类而言却是可变的。 | |||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
| 参数命名、顺序是否合理？ | 是 | ||
| 参数的个数是否太多？ | 否 | ||
| 是否使用类型和数目不确定的参数？ | 否 | ||
| 是否省略了函数返回值的类型？ | 否 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 否 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 是 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 是 | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 无malloc | |
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 否 | |
| 重要 | 数组或指针的下标是否越界？ | 否 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 是 | |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 是 | |
| 重要 | 是否修改“指向常量的指针”的内容？ | 否 | |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 否 | |
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 否 | |
| 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 无malloc | |
| 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 无动态数组 | |
| C++ 函数的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重载函数是否有二义性？ | 否 | ||
| 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | 否 | |
| 运算符的重载是否符合制定的编程规范？ | 是 | ||
| 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 | 否 | ||
| 重要 | 是否用内联函数取代了宏代码？ | 否 | |
| 类的构造函数、析构函数和赋值函数 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： | ||
| （1）缺省的无参数构造函数； | 否 | ||
| （2）缺省的拷贝构造函数； | 否 | ||
| （3）缺省的析构函数； | 否 | ||
| （4）缺省的赋值函数。 | 否 | ||
| 重要 | 构造函数中是否遗漏了某些初始化工作？ | 否 | |
| 重要 | 是否正确地使用构造函数的初始化表？ | 是 | |
| 重要 | 析构函数中是否遗漏了某些清除工作？ | 否 | |
| 是否错写、错用了拷贝构造函数和赋值函数？ | 否 | ||
| 重要 | 赋值函数一般分四个步骤： | ||
| （1）检查自赋值； | |||
| （2）释放原有内存资源； | |||
| （3）分配新的内存资源，并复制内容； | |||
| （4）返回 *this。是否遗漏了重要步骤？ | |||
| 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数？ | 是 | |
| 注意事项： | |||
| （1）派生类不可能继承基类的构造函数、析构函数、赋值函数。 | |||
| （2）派生类的构造函数应在其初始化表里调用基类的构造函数。 | |||
| （3）基类与派生类的析构函数应该为虚（即加virtual关键字）。 | |||
| （4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值 | |||
| 类的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背了继承和组合的规则？ | 否 | |
| （1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。 | |||
| （2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。 | |||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 否 | ||
| （２）存在不同数据类型的赋值吗？ | 否 | ||
| （３）存在不同数据类型的比较吗？ | 否 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 无错误 | ||
| （２）变量发生上溢或下溢吗？ | 无 | ||
| （３）变量的精度够吗？ | 精度足够 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 无 | ||
| （２）表达式中的优先级有误吗？ | 无 | ||
| （３）逻辑判断结果颠倒吗？ | 不颠倒 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 正确 | ||
| （２）无法正常终止（死循环）吗？ | 无死循环 | ||
| （３）错误地修改循环变量吗？ | 无 | ||
| （４）存在误差累积吗？ | 无 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 无 | ||
| （２）错误处理程序块一直没有机会被运行？ | 无 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 无毛病 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 不是 | ||
| 重要 | 文件I/O问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 否 | ||
- 评论
作为张斯豪同学的结对同伴，我对他简单严谨的代码风格表示十分的钦佩。同时我也意识到了，自己的代码并没有写版本号和版权归属人这样的关键问题。同时，他的代码每个函数前详细的注释也真正的让我理解了这个函数在本代码的作用。即使不需要读懂每一个for循环每一个if判断，也能对每个函数的作用有一个大概的了解。
同时，他的代码涉及到的内容十分详尽，具体有类的使用、文件的使用等等。可以说综合能力很优秀。综合考虑，张斯豪同学的代码既简单易读，又不失内容详实，知识面宽阔。对于他本人为什么能有如此好习惯，跟他本人的要求有很大关系。从开始他就确定了自己的努力方向，并且自学了很多知识，因此他才能有今天这样很强的专业能力。
但是，这份代码也并不是没有缺点。个人认为如果加using namespace std的话可以缩短很多的代码量。频繁的在cin和cout前加std::确实是一个很麻烦的事情。同时，到目前位置还存在的缺点是：慢，十分容易重构代码；缺乏计划性，对进阶编程了解不够全面。
能够与张斯豪同学一起进行这次结对作业是我的荣幸，希望能够和他继续配合，完成接下来的任务。
转载于:https://www.cnblogs.com/ulyssesgao/p/10768148.html
软件工程（2019）第一次结对作业相关推荐
- 软件工程实践2017第一次结对作业
结队项目--第一次作业 1. 结对成员: 031502614 赖志平 031502627 王国华 2.NABCD N (Need, 需求) 首先,提出的需求如下: 要解决的困扰:流程繁琐复杂,各个部门 ...
- 【软件工程】第一次阅读作业
项目 内容 这个作业属于哪个课程 软件工程(罗杰) 这个作业的要求在哪里 第一次阅读作业 本次作业要完成的目标 阅读<构建之法>,快速了解软件工程的相关知识和过程并提出疑问 读完<构 ...
- 北航 2012 秋季 现代软件工程 两人结对 作业要求
Pair Project: Elevator Scheduler [电梯调度算法的实现和测试] Design and implement an Elevator Scheduler to aim fo ...
- 软件工程实践2017结对作业
1.结对成员 031502643 朱晓健 031502626 孙浩楷 2.需求分析 Need 每到开学的时候,各大部门就会挤满青春广场通过各种方式来招收新成员.新生顶着烈日填写完申请表交由部门筛选,部 ...
- 【软件工程】第一次结对编程_作业
题目要求 (1). 首先在同学中找一个同伴,范围不限,可以在1~5班中随意组合,建议尽量不要找同组的成员,女同学尽量找男同学结对,但是不做强制要求: (2). 从以往个人完成的项目中选择一个作品,例如 ...
- 软件工程第一次结对作业
一.题目要求 (1). 首先在同学中找一个同伴,范围不限,可以在1~5班中随意组合,建议尽量不要找同组的成员,女同学尽量找男同学结对,但是不做强制要求: (2). 从以往个人完成的项目中选择一个作品, ...
- 软件工程第一次结对作业unity项目展示
使用软件: 1.unity 2.blender 3.mmd 学习内容: 1.unity用户UI界面设计 2.unity脚本&C#编程 3.blender建模 成果展示: unity软工作业演示 ...
- 软件工程第二次结对作业
四则运算生成器 任务 能够自动生成四则运算练习题 可以定制题目数量 用户可以选择运算符 用户设置最大数(如十以内.百以内等) 用户选择是否有括号.是否有小数 用户选择输出方式(如输出到文件.打印机等) ...
- 痛苦的对接体验——软工第一次结对作业
这次对接是痛苦的,痛苦的,痛苦的-- 对接中core组存在的问题: 参数标准不一.有些组需要表达式长度的参数,有些组需要操作符数量的参数,有些组对操作符做了捆绑操作(比如:'+-').不同的参数需要不 ...
最新文章
- java项目乱码_JavaWeb应用项目中文乱码的解决
- 衡阳之后，重估自动驾驶落地
- 网站***是如何用脚本欺骗网友的
- 超实用的 Mybatis 3.5 新特性
- 克莱姆森大学计算机排名,克莱姆森大学计算机科学computer science专业排名第401~500名（2020THE泰晤士高等教育世界大学排名）...
- C++中构造函数和析构函数的调用顺序
- reflective dll injection 反射注入
- linux下set和eval的使用小案例精彩解答
- S3 Texture Compression
- Qt Creator应用3D效果
- 台安变频器n2按键说明_台安N2变频器说明书.pdf
- IOS基础之绘图函数的使用
- myjdbc链接数据库.增删改查
- 你必须知道的Docker数据卷
- 弦图(Chordal Graph)学习小记
- AI教程之谷歌的新 Imagen 视频从文本生成视频
- 【muduo】TcpClient与TcpServer建立连接过程对比
- 计算机不识别固态硬盘,电脑经常不识别固态硬盘
- Hbase的数据切分
- android换肤动画,Android换肤(二) — 插件式换肤