作业四——结对作业
1 题目要求
- (1) 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
- (2). 将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
- (3). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
- (4). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
2 代码审查表
| 功能模块名称 | 利用子集构造法实现NFA到DFA的转换 | ||
| 审查人 | 蔡沛沛 | 审查日期 | 2018.4.6 |
| 代码名称 | 利用子集构造法实现NFA到DFA的转换 | 代码作者 | 李苗 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 否 | ||
| 重要 | 头文件是否使用了 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分支？ | 未用到 | |
| 重要 | 使用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的语句是否正确无误？ | 未用到 | |
| 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问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 未用到 | ||
| （２）文件以不正确的方式打开吗？ | 未用到 | ||
| （３）文件结束判断不正确吗？ | 未用到 | ||
| （４）没有正确地关闭文件吗? | 未用到 | ||
3 关于李苗的代码，我有话要说:)
三人行，必有我师焉。此次结对作业是在审查别人代码的同时反省自己的好机会。在不断的通过代码审查表检查别人代码的同时，对于同伴的优点我们会学习，对于她出现的问题我们会同时反省自己是否也有同样的问题。
对于我的同伴李苗的代码，总体来说，她的代码很整齐。每一部分都有明确的界限，能够让人看了一目了然，让人看了会很舒服，并没杂乱无章的感觉。对于每一部分函数，都有明确的定义，函数的名字让人看了就能很清楚的知道她的每一部分函数的作用，例如：对于Inspect()看了就知道是一个检查的函数，当然具体检查的内容还得通过分析函数的代码才能知道。对于大部分变量的定义，也有很清楚的定义，对于i，j之类的的变量是用于循环的变量无需多述，但是例如：name就知道这是一个关于名字的变量。她的代码循环部分里面的语句写的非常整齐，如下图所示，判断语句写得非常工整。同时，判断语句后面的注释，也是她的代码的一大优点，让人能够很清楚的知道抽象的代码的具体的意思。
当然，李苗的代码或多或少肯定会有缺点，这些缺点或大或小，改正后会让代码更加完善，同时对于我个人的代码规范，也起到一定的警醒作用。首先以上图为例，她的循环语句的“{”并没有另起一行，对于codeblocks，这个问题看似无可厚非，因为它会自动的检测你的括号是否对应完整，但是对于VC，每一个括号必须由你亲自打上去，这样假如你不另起一行提醒你循环完成后记得加“}”，势必会对整个代码的完成产生一定影响。其次，对于循环语句只有一句的代码，她并没有加“{}”，对于当前所要完成的任务，这样的问题肯定不会对整个的工作产生影响，但是假如说以后你要完善功能，要在这个循环语句里加入内容，是否有“{}”对工作的帮助就高下立见了。对于李苗的注释，首先它的存在无论对于她本人还是它的读者都是一大重要的帮助，注释可以让人更好更快的明确代码的作用，但是我认为她的注释离代码太近了，与代码有一定的距离可能会更好。最后，一个小小的问题，变量太多的时候，大家好像都有点词穷，会用一些意义不清楚的变量名称，这个问题稍加注意并且通过词汇量的积累就能够改善。
因为个人能力的问题，我提出的问题可能都是一些我和她都会犯的细节问题。但是，无论问题大小，发现问题然后解决问题，总归是一种进步。
最近喜欢鲁迅先生的一句话：“此后幸福的度日，合理地做人。”何谓：“合理”？一要温饱和生存，二要发展和进步。不仅生活如此，学习也是如此。应当不断的发现问题，然后解决问题，以此达到个人不断发展的目的。
代码地址：https://coding.net/u/lymiou1505_3/p/fushen/git/blob/master/main.cpp?public=true
此后幸福的度日，合理地做人。 ——引用自《我们怎样做父亲》
