软件工程结对编程第一次作业

结对编程 - 代码复审

作业要求

 (1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，建议尽量不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
 (2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
 (3). 将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
 (4). 对同伴的作品进行代码复审，并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容；
 (5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
 (6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点

结对伙伴及相关地址

• 伙伴 姚双合
• 伙伴的代码
• 我的代码

代码审查表

功能模块名称	Prim算法求最小生成树
审查人	孙治朝	审查日期	2019年4月23日
代码名称	源.cpp	代码作者	姚双合
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	是
	头文件和定义文件的目录结构是否合理？	是
	版权和版本声明是否完整？	否 只是课程设计，考虑的不多
重要	头文件是否使用了 ifndef/define/endif 预处理块?	是 同时用到了"typedef"
	头文件中是否只存放“声明”而不存放“定义”	否
程序的版式
重要性	审查项	结论
	空行是否得体？	是 函数块之间都有空行
	代码行内的空格是否得体？	是
	长行拆分是否得体？	没有出现长行
	“{” 和 “}” 是否各占一行并且对齐于同一列？	是
重要	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	是
重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	否 主函数中for循环执行一条语句，未加"{}"
重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	是 未加注释
重要	注释是否有错误或者可能导致误解？	未加注释
重要	类结构的public, protected, private顺序是否在所有的程序中保持一致？	没有使用到类
命名规则
重要性	审查项	结论
重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
	标识符是否直观且可以拼读？	是 极个别只用简单字符
	标识符的长度应当符合“min-length && max-information”原则？	是
重要	程序中是否出现相同的局部变量和全部变量？	否
	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是
	静态变量、全局变量、类的成员变量是否加前缀？	是 只是用到了全局变量
表达式与基本语句
重要性	审查项	结论
重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	否 判断语句中双目运算没有加括号
	是否编写太复杂或者多用途的复合表达式？	否
重要	是否将复合表达式与“真正的数学表达式”混淆？	否
重要	是否用隐含错误的方式写if语句? 例如
	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	否 未使用布尔变量
	（2）将浮点变量用“==”或“！=”与任何数字比较。	否
	（3）将指针变量用“==”或“！=”与NULL比较。	否
	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判
	断移到循环体的外面？	否
重要	Case语句的结尾是否忘了加break？	未使用Case语句
重要	是否忘记写switch的default分支？	未使用该语句
重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	未使用goto语句
常量
重要性	审查项	结论
	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是
	在C++ 程序中，是否用const常量取代宏常量？	否
重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	是
	是否误解了类中的const数据成员？因为const数据成员只在某个对象
	生存期内是常量，而对于整个类而言却是可变的。	未使用
函数设计
重要性	审查项	结论
	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
	参数命名、顺序是否合理？	是
	参数的个数是否太多？	否
	是否使用类型和数目不确定的参数？	否
	是否省略了函数返回值的类型？	否
	函数名字与返回值类型在语义上是否冲突？	不冲突
重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否
重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	没有使用
重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	没有使用
重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？	是
	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	未使用
内存管理
重要性	审查项	结论
重要	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）	未使用
重要	是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	未对数组赋初值
重要	数组或指针的下标是否越界？	否
重要	动态内存的申请与释放是否配对？（防止内存泄漏）	没有使用
重要	是否有效地处理了“内存耗尽”问题？	没有使用
重要	是否修改“指向常量的指针”的内容？	未使用
重要	是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。	否
重要	是否将malloc/free 和 new/delete 混淆使用？	未使用
重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	未使用
重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	未使用
其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？	没有
	（２）存在不同数据类型的赋值吗？	存在 int类型向char类型赋值
	（３）存在不同数据类型的比较吗？	不存在
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？	没有
	（２）变量发生上溢或下溢吗？	不发生
	（３）变量的精度够吗？	够 有一处不合理，从int类型到char类型，有精度损失
重要	逻辑判断问题：
	（１）由于精度原因导致比较无效吗？	没有
	（２）表达式中的优先级有误吗？	没有
	（３）逻辑判断结果颠倒吗？	没有
重要	循环问题：
	（１）循环终止条件不正确吗？	正确
	（２）无法正常终止（死循环）吗？	不存在
	（３）错误地修改循环变量吗？	否
	（４）存在误差累积吗？	不存在
重要	错误处理问题：
	（１）忘记进行错误处理吗？	没有进行空值处理
	（２）错误处理程序块一直没有机会被运行？	否
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	没有
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	不是

代码评价

  姚双合的代码实现的功能是：1、输入无向图的顶点和边的数据，建立该图的邻接矩阵；2、采用普里姆方法构造最小生成树，并输出结果；这个代码是数据结构课程设计的源代码，代码质量有一定的保证，因此在做代码复审时，就可以减少我的工作量。通过对姚双合的代码的复审，我从中发现了许多亮点，同时也找出了一些问题。但是总体来说，他的代码简明易懂，整体框架布局合理，让人看着很舒服。

• 整体代码的优点：
  • 能够用不同的代码模块实现不同功能，而不是将好多功能实现写在一段代码中；
  • 定义函数名、变量名时，都能够直观的拼读，让代码浏览者能够快速理解；
  • 代码整体符合代码规范化标准，例如：“{”和“}”各占一行、代码中的空行和代码行中的空格得体。
• 代码缺点：
  • 代码并没有声明版权版本；
  • 极个别变量定义只用了单个字母，这样不利于他人阅读，会出现阅读人猜变量含义的尴尬局面；
  • 代码没有注释，尤其是在关键函数部位；
  • 在函数体的“入口处”，并未对参数进行有效性检查。
  • 不同类型值之间赋值，造成了精度损失。比如：
    
    已经声明typedef char vextype，从int到char，可能丢失数据。

  代码复审，在这次作业之前从来没有接触过。以前写代码，唯一的目的就是实现功能，其他的很少考虑，最多考虑一下代码的结构的是否合理。但是做完这次代码复审后，发现以前自认为完美的代码还是会有这样那样的问题和隐患，这也就要求我在今后的编码过程中，更加关注代码的细节问题，比如代码规范、给关键部位加注释等等。这是第一次结对编程，感觉挺不错的。我和姚双合相互沟通，对目标代码有不理解的地方及时询问对方，从而避免了对目标代码的错误结论。

转载于:https://www.cnblogs.com/sunzhichao9/p/10756816.html