软件工程（2019）结对编程第一次作业
一、题目要求
(1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，建议尽量不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
(2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
(3). 将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
(4). 对同伴的作品进行代码复审，并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容；
(5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
(6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
二、代码地址
周清怡的代码地址
周清怡的博客地址
这份代码是周清怡的课设代码。
三、审查表
| 功能模块名称 | 使用lab8000模拟饮料装配过程 | ||
| 审查人 | 陈涌智 | 审查日期 | 2019.4.23 |
| 代码名称 | 模拟饮料装配线 | 代码作者 | 周清怡 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理，包括了51单片机的头文件 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 没有写版权声明 | ||
| 重要 | 头文件是否使用了 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 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 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问题： | 不发生IO | |
| （１）对不存在的或者错误的文件进行操作吗？ | 没有引用文件 | ||
| （２）文件以不正确的方式打开吗？ | 没有引用文件 | ||
| （３）文件结束判断不正确吗？ | 没有引用文件 | ||
| （４）没有正确地关闭文件吗? | 没有引用文件 | ||
四、代码评价
对于该次结对作业要求的代码复审问题，可能因为以前编写代码的时候从来没有考虑过需要看别人代码，所以看周清怡的代码对我来说有点挑战。
本次审查的代码是他的单片机课设，课设在lab8000实验箱上和proteus仿真上都完美运行了，所以代码的正确性是有保障的。
但是编码的风格还是有点问题。
对于这次的对于课设代码的复审，有以下几点：
优点：
1.主体有明显分隔。
代码中，函数与函数的间隔有很好的分开，而且一个主体中的两个花括号｛｝都有单独占一行，而且都相互对齐了。
2.代码功能有很大一部分独立出来了。
代码的很多功能都作为函数独立出来了，像对键盘的键值到键盘位置的映射函数，反过来的键盘位置到键值的映射函数，这两个函数对具体的键盘读入按键函数独立开了。同时独立出来的函数还有数码管显示函数，出错处理函数，还有定时器0的中断函数（定时器0用作数码管的动态显示）。定时器的初始化函数也做了单独函数处理。
3.定义变量统一在函数或者文件开头定义。
代码开头处，是申明变量的区域，和后面的函数独立开，而且对于关键常量：外部存储器的键盘行地址、键盘列地址、数码管段码地址在代码开头就定义了，这便于在更换外部存储器选址时的修改。
4.对之前想法的注释。
在键盘按键判断读入的函数中，注释了一些其他的方法，可能是他之前的想法，在对之前的想法有修改但是修改错误了，可以通过注释找到原想法的原码。
缺点：
1.定义的全局变量太多。
在代码开头处定义的数据太多，而且复杂。除去定义段码表和必要的串口值以外，其他的值没有具体的使用位置标注，而且都是全局变量，使用后不好销毁，这样编写，可能以后编写大型项目的时候会导致内存占用资源过大。
2.一些if语句、case语句一行有多句。
这可能是因为这几个语句中，对于部分判断，可能判断条件和判断后的执行语句都只有一行，而且很短，或者case的判断也少，执行只有一个简单的赋值，所以就写成了一行，甚至对于case，break段，有超过三个例子挤在同一行上。这可能在人的主观想法上看的较舒服，但是没有遵循代码规范。
3.代码中使用到了goto语句。
不能说goto不能用，而是代码中使用了goto语句的是键盘按键键值判断的函数，使用goto语句的部位的作用就是对六列键盘逐个赋值扫描，对按键键值判断。但是，这部分的代码冗余度过高，完全可以使用for循环代替。
4.main函数过长。
main函数负责了这个程序的开始部分和对读入判错以及程序各个主要数据的判断，但是main函数里的主要的部分都可以独立出main函数外。
5.对键值到键位的双向映射可以使用两个定义在代码区的断码表替代。
这么做可以省去查找一个键位数据需要调用两个函数的麻烦。
6.代码只在一个cpp文件里。
这样做会导致很多问题。在复查的时候，单独函数的查找和阅览的时间很大一部分会浪费在使用滚轮上，而且代码的质量会出问题。
五、总结
事实证明阅读他人代码确实是一件很累人的事情，而且，在只知道代码功能而不知道具体函数或者具体变量的功能和意义的情况下，阅读他人代码会更累。更别说不加注释的代码。
这次代码复审的作业，让我及其深刻地意识到了写代码的时候分文件的重要性和对函数功能加注释、对变量加注释的必要性。如果不这么做，他人阅读代码会很麻烦。甚至可以说自己在隔段时间后阅读代码也会很麻烦。
