代码复审

weixin_30460489

于 2018-04-06 16:28:00 发布

阅读量150

点赞数

原文链接：http://www.cnblogs.com/puxuebing/p/8727693.html

版权

合作伙伴: 胡泊

代码地址：https://coding.net/u/huboa/p/jieduizuoye/git/blob/master/jiedui?public=true

代码审查表：

功能模块名称	词法分析器
审查人	蒲雪冰	审查日期	2018/4/6
代码名称	jiedui	代码作者	胡泊
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	否
	头文件和定义文件的目录结构是否合理？	否
	版权和版本声明是否完整？	否
重要	头文件是否使用了 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的语句是否正确无误？	未使用类

其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？	否
	（２）存在不同数据类型的赋值吗？	否
	（３）存在不同数据类型的比较吗？	否
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？	否
	（２）变量发生上溢或下溢吗？	否
	（３）变量的精度够吗？	是
重要	逻辑判断问题：
	（１）由于精度原因导致比较无效吗？	否
	（２）表达式中的优先级有误吗？	否
	（３）逻辑判断结果颠倒吗？	否
重要	循环问题：
	（１）循环终止条件不正确吗？	否
	（２）无法正常终止（死循环）吗？	否
	（３）错误地修改循环变量吗？	否
	（４）存在误差累积吗？	否
重要	错误处理问题：
	（１）忘记进行错误处理吗？	是
	（２）错误处理程序块一直没有机会被运行？	未处理异常
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	未处理异常
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	未处理异常
重要	文件I/O问题：
	（１）对不存在的或者错误的文件进行操作吗？	未使用文件
	（２）文件以不正确的方式打开吗？	未使用文件
	（３）文件结束判断不正确吗？	未使用文件
	（４）没有正确地关闭文件吗?	未使用文件

审查结果：

(1).代码优点：

当我看到这个程序时，总体感觉还不错，在函数、变量命名方面很值得我学习，就感觉在看书上的代码一样，非常规范。如：isDigit函数、keyWord变量等让人一目了然就知道这个函数或者变量的作用，还可以通过函数名便知道函数的返回类型。整体排版也不错，每个函数与上下各空一行，清晰明了，每一个函数以及重要判定前都加有相关代码的注释，提高了程序的可阅读性，每个小功能独立成一个功能函数，提高了代码的可扩展性和代码复用性。

(2).代码存在的问题：

作为还是学生的我们，存在的问题总是比优点多的，下面就让我们一起来吐槽一下这份代码存在的一些问题，让我们一起发现并避免。

头文件：使用万能头文件bits/stdc++.h，会同时包含一些不需要的头文件，而且据了解国内一些OJ不支持万能头文件。
注释：未能正确使用单行注释“//”.
括号的使用：
- 相匹配的一对括号没有分别占一行并上下对齐。
- 对于判断条件下只有一行语句时未使用括号，使得代码不便扩展。
语句独立性：部分逻辑判断与执行语句在同一行，应各占一行
其他问题：
- main函数结束没有返回值，与函数返回类型int不符。
- 在多分枝判断部分对除需要以外的可能未进行判断，应使用用输出提示使用户知道导致错误的原因。
- 对于一些有实际意义却不好辨认的变量没用注释加以说明。