1.代码审查表
| 功能模块名称 | 停车场管理系统 | ||
| 审查人 | 孙晓宁 | 审查日期 | 2019/4/24 |
| 代码名称 | 停车场管理系统 | 代码作者 | 欧阳烨枫 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 不完整，并未声明 | ||
| 重要 | 头文件是否使用了 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数据成员只在某个对象 | 并未使用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问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 并未使用文件 | ||
| （２）文件以不正确的方式打开吗？ | 并未使用文件 | ||
| （３）文件结束判断不正确吗？ | 并未使用文件 | ||
| （４）没有正确地关闭文件吗? | 并未使用文件 | ||
2.GITHUB代码链接
3.代码评论
本次结对作业我审查的我的搭档的代码是关于停车场管理系统的。
根据我的理解，该代码实现的功能如下此停车场管理系统是在一个狭长的通道上的，而且只有一个大门可以供车辆进出，并且要实现停车场内某辆车要离开时，在它之后进入停车场的车都必须先退出停车场为它让路，待其开出停车场后，这些辆再依原来的次序进场的功能，就可以设计两个堆栈，其中一个堆栈用来模拟停车场，另一个堆栈用来模拟临时停车场，该临时停车场用来存放当有车辆离开时，原来停车场内为其让路的车辆。至于当停车场已满时，需要停放车辆的通道可以用一个循环队列来实现。当停车场内开走一辆车时，通道上便有一辆车进入停车场，此时只需要改变通道上车辆结点的连接方式就可以了，使通道上第一辆车进入停车场这个堆栈，并且使通道上原来的第二辆车成为通道上的第一辆车，此时只需将模拟通道的循环队列的头结点连到原来的第二辆车上就可以了。这个程序的关键是车辆的进站和出站操作，以及车场和通道之间的相互关系。由于车站是一个很窄的、一边开口的车道，先进后出，类似数据结构中的栈结构，故车场用栈这种数据结构来描述。外面的狭长的通道，先进先出，故可用队列结构来描述。
我的搭档使用的编程语言是C++，并充分的使用了栈和队列的特性，完美的实现了上述功能，头文件并无多余，运行结果没有，error和 warning。他使用类将车辆信息以及停车场信息分别进行分装，各类信息看起来清晰明确，对于变量的命名正确易于理解是我阅读起来舒服流畅，而在之后的操作中，使用了SWITCH CASE语句通过不同的按键实现了不同的功能，定义了栈和队列的基本函数，通过判断栈与队列的空否进行不同的操作输出不同的结果，对于指针的定义清晰明确，既没有多余的野指针也没有指针命名出现混淆，不同指针服务于不同的栈和队列，分工明确，结构清晰。关键部分注释清晰，阅读代码便可以理解其功能。
对于其功能的实现我通过运行代码以及阅读注释大致理解。首先输入停车场内已经存在车的车牌号，当车到达时，输入case 1: 首先判断停车场是否为空若停车场未满则进入停车，停车场满进入便道，如果他们都满的情况拒绝进入，如果挺近停车场或者候车场并输出停车位置。当车需要离开case 2: 首先判断该车是否存在若汽车存在输入车牌号取出车辆并计算输出停车费用若不存在则输出该车不存在。当汽车离开停车场判断便道内是否有车，如果有车便道内车进入停车场，否则，不执行任何指令如果想进行对车场的查询case 3: 输出停车场内车辆的车牌号。当需要候车场的查询时case 4: 输出候车场内车辆的车牌号。关闭系统case 0: 关闭系统。输入未知指令default: 输出未知指令并返回主菜单。
对于他的代码，我觉得虽有些许不足但是大体优秀，格式美观，功能全面，注释到位，我应当多向他请教学习。
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
