结对编程第一次作业（审查合作伙伴的代码）
审查合作伙伴的代码
合作人：王之光同学
一、题目要求
- (1)、 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
- (2)、将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
- (3)、将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
- (4)、对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
二、代码审查表
| 功能模块名称 | 指针链表的应用 | ||
| 审查人 | 何胜元 | 审查日期 | 2018/4/4 |
| 代码名称 | 超长整数处理程序 | 代码作者 | 王之光 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 完整 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 使用了define用于保存链表节点的大小 | |
| 头文件中是否只存放“声明”而不存放“定义” | 否 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 得体，代码风格正常 | ||
| 代码行内的空格是否得体？ | 得体 | ||
| 长行拆分是否得体？ | 得体 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 各占一行并且对齐于同一列 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 单行执行语句未加 | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 部分修饰符紧靠变量名 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 无 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 无类结构 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 保持一致 | |
| 标识符是否直观且可以拼读？ | 是 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ | 符合 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 遵守 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 无 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 已表达清楚 | |
| 是否编写太复杂或者多用途的复合表达式？ | 无 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 无 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | 无含有错误方式 | |
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 是 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 是 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 是 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判 | 否 | ||
| 断移到循环体的外面？ | 否 | ||
| 重要 | Case语句的结尾是否忘了加break？ | 否 | |
| 重要 | 是否忘记写switch的default分支？ | 否 | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无goto语句 | |
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 包含 | |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 无const数据成员 | ||
| 生存期内是常量，而对于整个类而言却是可变的。 | 是 | ||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 完整 | ||
| 参数命名、顺序是否合理？ | 合理 | ||
| 参数的个数是否太多？ | 否 | ||
| 是否使用类型和数目不确定的参数？ | 否 | ||
| 是否省略了函数返回值的类型？ | 否 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 无滥用 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 是 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 没有使用const | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 是 | |
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 否 | |
| 重要 | 数组或指针的下标是否越界？ | 无越界 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 配对 | |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 否 | |
| 重要 | 是否修改“指向常量的指针”的内容？ | 否 | |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 是 | |
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 否，全局使用malloc/free | |
| 重要 | 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问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 没有 | ||
| （２）文件以不正确的方式打开吗？ | 正确打开 | ||
| （３）文件结束判断不正确吗？ | 正确 | ||
| （４）没有正确地关闭文件吗? | 都正确关闭 | ||
三、总结
本次评论的程序是一份大一下学期C++的课设，是一个利用链表来将一个大整数分成若干个字符来存储于内存中，最后的输出是将每个存于链表中的字符减去‘0’的ASCII码，其差值便是存入的数值，通过放入数组再进行输出，是解决大整数问题的一个程序。王之光同学的代码在运行层面上没有任何bug，可见对于问题考虑的很全民，错误输入的处理很到位，值得我去学习。并且配以舒服的界面。
如下图所示：
虽然是大一下学期的程序，但王之光同学能清楚地认识到，程序是给人去使用的，良好的界面能大大提高人去使用的效率，试想在将来的工作中，如果想做一个手机app，所有的功能都没有问题，唯独界面不亲民，愿意去使用我们软件的用户应该不会有多少吧。良好的界面可以让用户清晰地了解应用的功能和内容组织,还可以让用户更快更好的完成操作任务和信息查找。其次作为一个用户而言，对于一个软件的初认识就是界面。
下面来聊聊代码本身，程序的版式采用的是‘{’与‘}’都单独存一行，变量名称与运算符号之间用‘ ’空格来隔开，单行的if while等句子未用花括号框起，整体代码看起来很好识别，不会给人一种不舒服的感觉。
内存管理方面良好，建立链表时没有申请无用内存的现象，拥有析构函数，及时回收了过期的内存，性能良好。
变量函数命名方面做得欠佳，出现了拼音形式的函数名，十分不提倡这种命名方式。良好的代码命名能使程序员一目了然，省去很多麻烦。
下面贴上代码变量和函数命名规范：
-- 引用自 vic-chen 的代码变量和函数命名规范一文
总的来说王之光的代码对于一个大一下学期的学生来说还算是合格的，在细节方面欠佳，希望继续努力。通过本次的代码审查我也发现了自身的不足，取长补短才是我应该做的。
