同伴代码的coding地址
这是我同伴李健的代码的coding地址:代码审核表功能模块名称 | 求树中的哪一层具有m个节点,并返回层数。 | ||||
审查人 | 李佳昕 | 审查日期 | 2019年4月23日 | ||
代码名称 | 源代码.cpp | 代码作者 | 李健 | ||
文件结构 | |||||
重要性 | 审查项 | 结论 | |||
头文件和定义文件的名称是否合理? | 合理 | ||||
头文件和定义文件的目录结构是否合理? | 合理 | ||||
版权和版本声明是否完整? | 无版权和版本声明 | ||||
重要 | 头文件是否使用了 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? | 无Case语句 | |||
重要 | 是否忘记写switch的default分支? | 无switch语句 | |||
重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无goto语句 | |||
常量 | |||||
重要性 | 审查项 | 结论 | |||
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? | 是 | ||||
在C++ 程序中,是否用const常量取代宏常量? | 否 | ||||
重要 | 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? | 否 | |||
是否误解了类中的const数据成员?因为const数据成员只在某个对象生存期内是常量,而对于整个类而言却是可变的。 | 没有使用类 | ||||
函数设计 | |||||
重要性 | 审查项 | 结论 | |||
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 | 完整 | ||||
参数命名、顺序是否合理? | 合理 | ||||
参数的个数是否太多? | 不太多 | ||||
是否使用类型和数目不确定的参数? | 否 | ||||
是否省略了函数返回值的类型? | 否 | ||||
函数名字与返回值类型在语义上是否冲突? | 否 | ||||
重要 | 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 | 否 | |||
重要 | 在函数体的“入口处”,是否用assert对参数的有效性进行检查? | 没使用assert | |||
重要 | 使用滥用了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。 | |||||
其它常见问题 | |||||
重要性 | 审查项 | 结论 | |||
重要 | 数据类型问题: | ||||
(1)变量的数据类型有错误吗? | 无 | ||||
(2)存在不同数据类型的赋值吗? | 不存在 | ||||
(3)存在不同数据类型的比较吗? | 不存在 | ||||
重要 | 变量值问题: | ||||
(1)变量的初始化或缺省值有错误吗? | 没有 | ||||
(2)变量发生上溢或下溢吗? | 没发生 | ||||
(3)变量的精度够吗? | 较为精确 | ||||
重要 | 逻辑判断问题: | ||||
(1)由于精度原因导致比较无效吗? | 没有 | ||||
(2)表达式中的优先级有误吗? | 没有 | ||||
(3)逻辑判断结果颠倒吗? | 不颠倒 | ||||
重要 | 循环问题: | ||||
(1)循环终止条件不正确吗? | 终止条件正确 | ||||
(2)无法正常终止(死循环)吗? | 没有此情况 | ||||
(3)错误地修改循环变量吗? | 没有此情况 | ||||
(4)存在误差累积吗? | 不存在 | ||||
重要 | 错误处理问题: | ||||
(1)忘记进行错误处理吗? | 没有 | ||||
(2)错误处理程序块一直没有机会被运行? | 有机会被运行 | ||||
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 | 是 | ||||
(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | 不是 | ||||
重要 | 文件I/O问题: | ||||
(1)对不存在的或者错误的文件进行操作吗? | 未使用文件 | ||||
(2)文件以不正确的方式打开吗? | 未使用文件 | ||||
(3)文件结束判断不正确吗? | 未使用文件 | ||||
(4)没有正确地关闭文件吗? | 未使用文件 | ||||
代码评价
我同伴的代码实现的功能是:在一棵二叉树中,给定节点数量值m,求树中的哪一层具有m个节点,并返回层数。如果同时存在多层具有m个节点,则返回数值最小的层数;如果没有节点数量为m的层,则返回0。按先序遍历序列建立链式存储结构的二叉树。 下面从代码本身来谈一下优缺点:优点:
从需求分析角度来说,该程序可以大致上完成题目要求。
从代码结构角度来说,整体上来看较为工整,层次也比较清晰。 该代码最大的特点就是不像之前学习时的一样将所有代码全部写在主函数里,而是在主函数外部将所有要使用的函数定义完成使得主函数看起来十分简洁,并且让功能性函数独立化,便于添加和修改,同时独立的程序开发模式,有效的缩短了程序的开发周期。 从命名规范角度来说,该代码用了大部分专有名词使得代码看起来很专业。缺点:
代码注释较少,若果非本人查看的话需要花费一些时间去弄懂部分语句的功能
在定义数组时为给数组赋初值。 用malloc申请内存空间后未使用free函数释放内存。总体评价:
从该同学的代码中我们可以看出该同学对树的建立和遍历都有一定的理解,对结构体的设计也比较合理,并且利用#define定义了一些常用的量来节省空间,都能体现出用了一定心思在写这份代码,证明该同学对c/c++的使用也很熟练。但也可看出有一些不足的地方,例如InitStack函数,函数内容仅仅是对一个变量赋值,而 PostOrder却写了一大串,很容易让看代码的人在阅读此代码时忘记其中一些函数的含义,并且算法还可以进行扩展。总的来说,不管是从代码风格、格式等角度都可以看出这并非是一个初学者或是一个刚接触一些皮毛的人所写的代码,而是一名合格计算机专业学生所写的东西。由于是第一次结对编程,还未涉及到一起编程,希望接下来的工作中我们可以一起做得更好。
同伴的博客地址