软件工程第一次结对作业

##复查代码地址 小伙伴的跳表skiplist程序 ##复审表格
功能模块名称 Skip List的设计与实现
审查人 蒋有志 审查日期 2019.4.22　
代码名称 跳表.cpp 代码作者 马宝贺
文件结构
重要性       审查项 结论
                 头文件和定义文件的名称是否合理？ 合理　
　 头文件和定义文件的目录结构是否合理？ 　
　 版权和版本声明是否完整？ 不完整　
重要 头文件是否使用了 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？ 未使用Caase语句
重要 是否忘记写switch的default分支？ 未使用switch语句　
重要 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 未使用goto语句　
　 　 　
常量 
重要性       审查项 结论
　 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ 是　
　 在C++ 程序中，是否用const常量取代宏常量？ 未使用　
重要 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ 否
　 是否误解了类中的const数据成员？因为const数据成员只在某个对象 未使用类　
　 生存期内是常量，而对于整个类而言却是可变的。 未使用类 　
　 　 　
函数设计 
重要性       审查项 结论
　 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 书写完整　
　 参数命名、顺序是否合理？ 合理
　 参数的个数是否太多？ 否　
　 是否使用类型和数目不确定的参数？ 否　
　 是否省略了函数返回值的类型？ 否　
　 函数名字与返回值类型在语义上是否冲突？ 否　
重要 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 　
重要 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ 否　
重要 使用滥用了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的语句是否正确无误？ 未使用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问题： 　
　 （１）对不存在的或者错误的文件进行操作吗？ 未使用文件　
　 （２）文件以不正确的方式打开吗？ 未使用文件　
　 （３）文件结束判断不正确吗？ 未使用文件　
　 （４）没有正确地关闭文件吗? 未使用文件　
　 　 　
##总结   这次我的结对小伙伴是马宝贺，他我的同班同学也是我的室友，所以我对他编写代码的风格还是比较了解的。下面我就来分析分析他的代码的优缺点。
  缺点：头文件、变量的定义、结构体的定义、函数的设计就会发现还是有许多的小问题。比如头文件，他没有将头文件和define定义之后再进行结构体的定义，而是结构体的定义之后又有了define定义。这样书写首先结构比较混乱，没有一个清晰的条理，让读他代码的人也感觉不到清晰明朗。其次，在函数中malloc的使用，他没有在malloc申请内存之后没有立即检查指针是否为空，没有想到避免使用指针为空的内存。还有就是{ }的使用，在他的代码中，有些地方 { 或者 }并没有单独占一行，还有些地方上一个{或者 }与下一个{或者}对齐了，这样看着不是很整齐，而且很难看清楚这些之间的从属与逻辑关系。函数失败时未做出错处理。
  优点：对于在函数中要常用的常量使用了define定义，而且编写的函数名可读性较好，可以不用看注释和代码体就可以知道该函数的功能是什么。
  通过使用复审表格来复审别人的代码，我也知道了自己在编写代码时的不足。对于他的一些缺点，我同样也存在，例如：“{ }”的使用就不符合代码规范；定义变量时，为了书写方便，同种数据类型的变量定义在了一行；函数名称上的定义可读性不高；没有编写出错处理代码。子曰：“见贤思齐焉，见不贤而内自省也”