软件工程结对作业1

1. 作业说明

    本次软件工程结对作业是与1634010103班的马行建同学合作共同完成。我审查的是他的数据结构课设名为 简单文本编辑器的代码。他的 博客地址。他审查的是我的数据结构课设名为实现关键路径的算法的代码

2. 代码复审

   设计好代码审查表，按照代码审查表上的条目，一项一项进行代码审查。 代码审查表如下：

表1 代码审查表

功能模块名称
审查人	焦任战	审查日期	2019.04.23
代码名称	简单文本编辑器	代码作者	马行建
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	合理
	头文件和定义文件的目录结构是否合理？	合理
重要	头文件是否使用了 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？	否
重要	是否忘记写switch的default分支？	否
常量
重要性	审查项	结论
	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是
	在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的语句是否正确无误？	是
其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？	没有
	（２）存在不同数据类型的赋值吗？	不存在
	（３）存在不同数据类型的比较吗？	不存在
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？	没有
	（２）变量发生上溢或下溢吗？	没有
	（３）变量的精度够吗？	够
重要	逻辑判断问题：
	（１）由于精度原因导致比较无效吗？	没有
	（２）表达式中的优先级有误吗？	没有
	（３）逻辑判断结果颠倒吗？	不颠倒
重要	循环问题：
	（１）循环终止条件不正确吗？	正确
	（２）无法正常终止（死循环）吗？	没有
	（３）错误地修改循环变量吗？	没有
	（４）存在误差累积吗？	没有
重要	错误处理问题：
	（１）忘记进行错误处理吗？	是

# 3. 对同伴代码的评论 ## 3.1 看了马行健同学的代码后的感想     从马同学那里得到他的代码后，我首先没有看他的代码，而是直接运行起来去使用他的这个简易的文本编辑器，运行起来后界面中间是个字符打印的电脑（如图1），下面是使用导向，给人很高大上的感觉。接下来我认真的操作了一把，程序的运行结果与预期一致，程序用户体验良好。最后就是阅读代码了，马同学的代码，总体上代码结构清晰，注释详细得当。 ## 3.2 马同学代码中不足之处的汇总     经过代码复审，代码中好的地方就不过多陈述了，下面列出马同学代码中的一些不足之处:

• 一行代码不是只做一件事，应该只定义一个变量，只写一条语句。

• 命名规则没有与所采用的操作系统或开发工具的风格保持一致。

• 部分标识符不直观且可以拼读。

• 程序中出现相同的局部变量和全部变量。

• 没有进行错误处理。

• 忘记为数组和动态内存赋初值（防止将未被初始化的内存作为右值使用）。

    复审马同学代码时，我发现了他代码有很多值得我学习的地方。这些点很多都是我平常写代码的时候忽略的。 同时，我也发现了自己的代码也有和马同学代码中有命名不规范、代码结构设计不合理等问题。

3.3 与君共勉

    三人行，必有我师。互相学习，互相进步，加油！