软件工程（2019）结对编程第一次作业
一、题目要求
(1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，建议尽量不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
(2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
(3). 将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
(4). 对同伴的作品进行代码复审，并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容；
(5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
(6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
二、代码地址
三、代码审查表
| 项目名称 | 链表建立及基本操作 | |||
| 审查人 | 高放 | 审查日期 | 2019/4/23 | |
| 代码名称 | 软件工程作业.cpp | 代码作者 | 关伟琦 | |
| 文件结构 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 1 | 头文件和定义文件的名称是否合理？ | 是 | ||
| 2 | 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 3 | 版权和版本声明是否完整？ | 不适用 | 数据结构课程设计，无需版权信息 | |
| 4 | 头文件是否使用了 ifndef/define/endif 预处理块? | 重要 | 不适用 | 未使用自订的头文件 |
| 5 | 头文件中是否只存放“声明”而不存放“定义”？ | 不适用 | 未使用自订的头文件 | |
| 程序版式 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 6 | 代码段间的空行是否得体？ | 否 | 代码段间未用空行 | |
| 7 | 代码行内的空格是否得体？ | 否 | 未按标准规范 | |
| 8 | 长行拆分是否得体？ | 否 | 部分较长语句未换行 | |
| 9 | “{” 和 “}” 是否各占一行并且对齐于同一列？ | 否 | "{"单独占一行但没有对齐 | |
| 10 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 重要 | 否 | 部分语句在一行内定义了多个变量 |
| 11 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 重要 | 是 | |
| 12 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？ | 重要 | 是 | |
| 13 | 注释是否清晰并且必要？ | 重要 | 否 | 未写注释 |
| 14 | 注释是否没有错误且不会导致误解？ | 重要 | 不适用 | 未写注释 |
| 15 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 重要 | 不适用 | 未使用类 |
| 命名规则 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 16 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 重要 | 是 | |
| 17 | 标识符是否直观且可以拼读？ | 是 | ||
| 18 | 标识符的长度应当符合“min-length && max-information”原则？ | 是 | ||
| 19 | 程序中是否出现相同的局部变量和全部变量？ | 重要 | 否 | 未出现全部变量 |
| 20 | 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | ||
| 21 | 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | ||
| 表达式与基本语句 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 22 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺 | 重要 | 是 | |
| 23 | 是否编写太复杂或者多用途的复合表达式？ | 否 | ||
| 24 | 是否将复合表达式与“真正的数学表达式”混淆？ | 重要 | 否 | |
| 25 | 是否用正确的方式写if语句? 例如 | 重要 | 是 | |
| 1) 将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | |||
| 2) 将浮点变量用“==”或“！=”与任何数字比较。 | 否 | 未使用浮点型变量 | ||
| 3) 将指针变量用“==”或“！=”与NULL比较。 | 是 | |||
| 26 | 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体外面？ | 否 | ||
| 27 | Case语句的结尾是加了break？ | 重要 | 不适用 | 未使用switch语句 |
| 28 | 是否写了switch的default分支？ | 重要 | 不适用 | 未使用switch语句 |
| 29 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化，重要的计算等。 | 重要 | 不适用 | 未使用goto语句 |
| 常量 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 30 | 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 否 | 未多次出现数字或字符串 | |
| 31 | 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 不适用 | 未使用类 | |
| 32 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 重要 | 是 | |
| 33 | 生存期内是常量，而对于整个类而言却是可变的。 | 是 | ||
| 函数设计 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 34 | 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
| 35 | 参数命名、顺序是否合理？ | 是 | ||
| 36 | 参数的个数是否太多？ | 否 | ||
| 37 | 是否使用类型和数目不确定的参数？ | 否 | ||
| 38 | 是否省略了函数返回值的类型？ | 否 | ||
| 39 | 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 40 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 重要 | 否 | |
| 41 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 重要 | 否 | 未使用assert |
| 42 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且 | 重要 | 否 | 未使用assert |
| 43 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 重要 | 是 | |
| 44 | 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | 未使用const | |
| 内存管理 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 45 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？ | 重要 | 否 | 未检查指针值是否为NULL |
| 46 | 是否忘记为数组和动态内存赋初值？ | 重要 | 否 | |
| 47 | 数组或指针的下标是否越界？ | 重要 | 否 | |
| 48 | 动态内存的申请与释放是否配对？ | 重要 | 是 | |
| 49 | 是否有效地处理了“内存耗尽”问题？ | 重要 | 否 | |
| 50 | 是否修改“指向常量的指针”的内容？ | 重要 | 否 | 指针未指向常量 |
| 51 | 是否出现野指针？例如 | 重要 | ||
| 1) 指针变量没有被初始化 | 是 | |||
| 2) 用free或delete释放了内存之后，忘记将指针设置为NULL。 | 是 | |||
| 52 | 是否将malloc/free 和 new/delete 混淆使用？ | 重要 | 否 | |
| 53 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 重要 | 是 | |
| 54 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 重要 | 不适用 | 未使用动态对象数组 |
| 其它常见问题 | ||||
| 序号 | 审查项目 | 重要性 | 结论 | 备注 |
| 55 | 数据类型问题： | 重要 | ||
| 1) 变量的数据类型有错误吗？ | 否 | |||
| 2) 存在不同数据类型的赋值吗？ | 否 | |||
| 3) 存在不同数据类型的比较吗？ | 否 | |||
| 56 | 变量值问题： | 重要 | ||
| 1) 变量的初始化或缺省值有错误吗？ | 否 | |||
| 2) 变量发生上溢或下溢吗？ | 否 | |||
| 3) 变量的精度够吗? | 是 | |||
| 57 | 逻辑判断问题： | 重要 | ||
| 1) 由于精度原因导致比较无效吗？ | 否 | |||
| 2) 表达式中的优先级有误吗？ | 否 | |||
| 3) 逻辑判断结果颠倒吗？ | 否 | |||
| 58 | 循环问题： | 重要 | ||
| 1) 循环终止条件不正确吗？ | 否 | |||
| 2) 无法正常终止（死循环）吗？ | 否 | |||
| 3) 错误地修改循环变量吗？ | 否 | |||
| 4) 存在误差累积吗？ | 否 | |||
| 59 | 错误处理问题： | 重要 | 未编写错误处理程序 | |
| 1) 忘记进行错误处理吗？ | 没有错误 | |||
| 2) 错误处理程序块一直没有机会被运行？ | 不适用 | |||
| 3) 错误处理程序块本身就有毛病吗？ | 不适用 | |||
| 4) 错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 不适用 | |||
| 60 | 文件I/O问题： | 重要 | 未对文件进行操作 | |
| 1) 对不存在的或者错误的文件进行操作吗？ | 不适用 | |||
| 2) 文件以不正确的方式打开吗？ | 不适用 | |||
| 3) 文件结束判断不正确吗？ | 不适用 | |||
| 4) 没有正确地关闭文件吗? | 不适用 | |||
2、缺点：
代码没有注释，不方便读者理解；
代码中相应的“{ }”没有对齐;
代码运用指针，使用了malloc语句创建空间，创建完成后，并没有指明为空指针；
代码未进行了错误处理，当输入出现错误时，并没有提示出错。
五、总结
通过这次的组队作业，学到了如何进行代码评审，知道代码规范的重要性，并且在今后编程的时候用这些要求规范自己；我审查的是关伟琦同学编写的链表的建立与基本操作，虽然挺复杂，但是思路清晰明了，在之前虽然也学过但是基本也忘得差不多了，通过对关伟琦同学代码的浏览，我又重新对链表有了一些新的认识；不过，他的代码规范性做的不够好，这些我会和他沟通交流，并且改进；我相信通过之后的磨合，我俩会成为很好的伙伴，在学习的道路上一发不可收。
