软件工程（2019）结对编程第一次作业

蒋有志童鞋的代码程序

功能模块名称	停车场管理系统
审查人	马宝贺	审查日期	2019.4.22
代码名称	main.cpp	代码作者	蒋有志
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	是
	头文件和定义文件的目录结构是否合理？	是
	版权和版本声明是否完整？	不适用
重要	头文件是否使用了 ifndef/define/endif 预处理块?	不适用
	头文件中是否只存放“声明”而不存放“定义”	不适用
程序的版式
重要性	审查项	结论
	空行是否得体？	是
	代码行内的空格是否得体？	部分得体
	长行拆分是否得体？	是
	“{” 和 “}” 是否各占一行并且对齐于同一列？	是
重要	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	否
重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	否
重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	没有注释
重要	注释是否有错误或者可能导致误解？	注释较少
命名规则
重要性	审查项	结论
重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
	标识符是否直观且可以拼读？	是
	标识符的长度应当符合“min-length && max-information”原则？	是
重要	程序中是否出现相同的局部变量和全部变量？	是
	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	否
	静态变量、全局变量、类的成员变量是否加前缀？	否
表达式与基本语句
重要性	审查项	结论
重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	是
	是否编写太复杂或者多用途的复合表达式？	否
重要	是否将复合表达式与“真正的数学表达式”混淆？	否
重要	是否用隐含错误的方式写if语句? 例如
	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	否
	（2）将浮点变量用“==”或“！=”与任何数字比较。	否
	（3）将指针变量用“==”或“！=”与NULL比较。	否
	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判	不适用
	断移到循环体的外面？
重要	Case语句的结尾是否忘了加break？	否
重要	是否忘记写switch的default分支？	否
重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	不适用
常量
重要性	审查项	结论
	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是
	在C++ 程序中，是否用const常量取代宏常量？	否
重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	否
函数设计
重要性	审查项	结论
	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
	参数命名、顺序是否合理？	是
	参数的个数是否太多？	是
	是否使用类型和数目不确定的参数？	否
	是否省略了函数返回值的类型？	否
	函数名字与返回值类型在语义上是否冲突？	否
重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否
重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	否
重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	否
重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？	否
	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	否
内存管理
重要性	审查项	结论
重要	是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	是
重要	是否将malloc/free 和 new/delete 混淆使用？	否
重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	不适用
重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	不适用
其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？	否
	（２）存在不同数据类型的赋值吗？	否
	（３）存在不同数据类型的比较吗？	否
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？	否
	（２）变量发生上溢或下溢吗？	否
	（３）变量的精度够吗？	够
重要	逻辑判断问题：
	（１）由于精度原因导致比较无效吗？	否
	（２）表达式中的优先级有误吗？	否
	（３）逻辑判断结果颠倒吗？	否
重要	循环问题：
	（１）循环终止条件不正确吗？	否
	（２）无法正常终止（死循环）吗？	否
	（３）错误地修改循环变量吗？	否
	（４）存在误差累积吗？	否
重要	错误处理问题：
	（１）忘记进行错误处理吗？	否
	（２）错误处理程序块一直没有机会被运行？	否
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	否
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	否
重要	文件I/O问题
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

评论：

　　蒋有志童鞋是我的同班同学也是我大学的室友，所以我很了解蒋有志学识的渊博，以及他代码技艺的精湛，这次代码复审，我很好奇蒋有志同学的代码会不会出现一些错误，以下是我对他代码的评论。

　　优点：代码清晰完整，在程序运行之后界面十分整洁，让人赏心悦目。一些常见的问题，如：精度不准，逻辑错误，都没有在他的代码中出现。函数名定义也直观可拼读，可以很容易的看出他的功能函数的作用。以及文件的打开与关闭，很容易出错的地方，都没有犯错。

　　缺点：代码行内的空格存在部分不得体；有些标识符不是很直观；{}的使用不符合规范；函数的入口缺少assert检查；以及部分函数变量过多，看起来有些许费劲，以及最重要的是注释过少，只简单的注释了一些函数的作用，但是函数内关键的语句却没有注释，这样的注释过少的问题会使其他同学或老师在理解他代码含义上出现一些困难。

　　总的来说，蒋有志童鞋的代码大体上符合代码审查表的规定，当然也有一些小的问题存在，而这些错误，我也犯了很多，如{}的书写，代码的格式等等。通过这次审查蒋有志童鞋的代码，在感叹蒋有志功力深厚的同时，我也反思了一些我存在的错误，可谓是获益匪浅，希望在以后的敲代码的生活里我能少犯相同的错误，时时刻刻向蒋有志童鞋学习。

参考资料：C/C++审查表