合作伙伴

向浩伟博客地址

所审查代码coding

代码审查

功能模块名称实现C语言小子集程序的词法分析审查人张泽中审查日期2017.4.6代码名称简单的词法分析程序代码作者张泽中文件结构重要性审查项结论头文件和定义文件的名称是否合理？合理头文件和定义文件的目录结构是否合理？合理版权和版本声明是否完整？不完整重要头文件是否使用了 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问题：（１）对不存在的或者错误的文件进行操作吗？否（２）文件以不正确的方式打开吗？否（３）文件结束判断不正确吗？否（４）没有正确地关闭文件吗?否

个人点评

这是我第一次来审查别人的代码，俗话说的好，三人行必有我师焉。取他人之所长，补己之短，我想这是老师设计这个作业的初衷。我所审查的队友的代码，我也曾经编译过类似的，所以在我审查时，就与我的代码进行了一下比较，发现各有优劣，不过整体来说还是很不错的。 优点：（1）在规范书写方面做得很好，就好像写英语作文一样，单词和语法均正确的话，读者就能更快地了解意思，队友的书写非常规范，能让我很清楚的每一个小子程序。（2）还有就是在变量、函数名、结构体的定义上也做的非常好。绝大多数的定义中，都是根据将要实现的功能来进行的定义，使人在看到定义就能大概猜测出将要做的事情，使人在读代码的时候感到比较轻松，更易读懂。（3）程序进行了模块化的处理，即将主程序的几个比较重要的功能，都写成了子函数，通过返回值的形式来实现程序功能。这样做的好处一是让程序更加有条理，简化过程；二是在程序出错时，可以逐一对子函数进行检验，而不用对整个大程序进行检测，更加方便快捷。 缺点：主要代码是功能不齐全，队友代码的功能是实现C语言小子集程序的词法分析，但是有一种错误的词类识别不了，就是字母+多个数字+字母的类型，比如：aa5555bb。所以功能有点小缺陷，希望可以加以改正。 这是比一次接触结对编程，第一次体验团结的意味，希望在接下来的工作中，各自发挥自己的特长，来共同圆满的完成老师交给的任务。

转载于:https://www.cnblogs.com/zt960515/p/8729201.html

相关资源：JAVA上百实例源码以及开源项目