1、代码地址
2、C/C++审核表
参照C/C++审核表,对项目代码进行审核。
功能模块名称 | 科学计算器软件设计 | ||
审查人 | 王越 | 审查日期 | 2019-04-23 |
代码名称 | 结对作业.cpp | 代码作者 | 张雨蝶 |
文件结构 | |||
重要性 | 审查项 | 结论 | |
头文件和定义文件的名称是否合理? | c语言头文件和C++头文件混用 | ||
头文件和定义文件的目录结构是否合理? | 合理 | ||
版权和版本声明是否完整? | 不需考虑版权问题,单纯属于作业。 | ||
重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 未使用 | |
头文件中是否只存放“声明”而不存放“定义” | 未使用 | ||
程序的版式 | |||
重要性 | 审查项 | 结论 | |
空行是否得体? | 不得体,每一段代码之间无空行。 | ||
代码行内的空格是否得体? | 合格 | ||
长行拆分是否得体? | 不得体,少部分代码过长,未及时换行与整理。 | ||
“{” 和 “}” 是否各占一行并且对齐于同一列? | 合格 | ||
重要 | 一行代码是否只做一件事?如只定义一个变量,只写一条语句。 | 部分一行代码定义多个变量 | |
重要 | If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 | 部分只有一句有效语句,无{} | |
重要 | 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? | 修饰符正确,注释清晰明了表明每个功能块的作用。 | |
重要 | 注释是否有错误或者可能导致误解? | 注释正确,但还不是很完善,让人一眼看不是很透彻。 | |
重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致? | 未用到面向对象 | |
命名规则 | |||
重要性 | 审查项 | 结论 | |
重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致? | 一致 | |
标识符是否直观且可以拼读? | 标识符直观但部分不可读 | ||
标识符的长度应当符合“min-length && max-information”原则? | 满足 | ||
重要 | 程序中是否出现相同的局部变量和全部变量? | 部分的局部变量有相同的存在 | |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? | 遵循 | ||
静态变量、全局变量、类的成员变量是否加前缀? | 未加前缀 | ||
表达式与基本语句 | |||
重要性 | 审查项 | 结论 | |
重要 | 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? | 清楚地确定表达式的操作顺序 | |
是否编写太复杂或者多用途的复合表达式? | 未出现太过复杂和多用途表达式 | ||
重要 | 是否将复合表达式与“真正的数学表达式”混淆? | 未 | |
重要 | 是否用隐含错误的方式写if语句? 例如 | ||
(1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 出现,判断布尔变量是否与TRUE相同 | ||
(2)将浮点变量用“==”或“!=”与任何数字比较。 | 未出现浮点数比较 | ||
(3)将指针变量用“==”或“!=”与NULL比较。 | 未出现于NULL比较的情况 | ||
如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判断移到循环体的外面? | 每个逻辑判断在循环中都是必要的 | ||
重要 | Case语句的结尾是否忘了加break? | 正确的加入break语句 | |
重要 | 是否忘记写switch的default分支? | 正确写入 | |
重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 未使用goto语句 | |
常量 | |||
重要性 | 审查项 | 结论 | |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? | 未使用 | ||
在C++ 程序中,是否用const常量取代宏常量? | 未使用const常量 | ||
重要 | 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? | 未使用常量 | |
是否误解了类中的const数据成员?因为const数据成员只在某个对象 | 未使用类 | ||
生存期内是常量,而对于整个类而言却是可变的。 | 未使用 | ||
函数设计 | |||
重要性 | 审查项 | 结论 | |
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 | 正确 | ||
参数命名、顺序是否合理? | 合理 | ||
参数的个数是否太多? | 未过多 | ||
是否使用类型和数目不确定的参数? | 未使用 | ||
是否省略了函数返回值的类型? | 未省略函数返回值类型 | ||
函数名字与返回值类型在语义上是否冲突? | 未出现冲突 | ||
重要 | 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 | 输出都在主函数中显示 | |
重要 | 在函数体的“入口处”,是否用assert对参数的有效性进行检查? | 未使用 | |
重要 | 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 | 未使用 | |
重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”? | 使用返回值指向栈内存 | |
是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need” | 未使用const | ||
内存管理 | |||
重要性 | 审查项 | 结论 | |
重要 | 用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存) | 未使用malloc与类 | |
重要 | 是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) | 未给数组赋初值 | |
重要 | 数组或指针的下标是否越界? | 未越界 | |
重要 | 动态内存的申请与释放是否配对?(防止内存泄漏) | 未使用动态内存 | |
重要 | 是否有效地处理了“内存耗尽”问题? | 是 | |
重要 | 是否修改“指向常量的指针”的内容? | 未有常量 | |
重要 | 是否出现野指针?例如(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)存在不同数据类型的赋值吗? | 存在不同类型之间的复制,如int到float,double到float | ||
(3)存在不同数据类型的比较吗? | 不存在 | ||
重要 | 变量值问题: | ||
(1)变量的初始化或缺省值有错误吗? | 正确 | ||
(2)变量发生上溢或下溢吗? | 未发生 | ||
(3)变量的精度够吗? | 足够 | ||
重要 | 逻辑判断问题: | ||
(1)由于精度原因导致比较无效吗? | 无 | ||
(2)表达式中的优先级有误吗? | 未有 | ||
(3)逻辑判断结果颠倒吗? | 无 | ||
重要 | 循环问题: | ||
(1)循环终止条件不正确吗? | 无 | ||
(2)无法正常终止(死循环)吗? | 无 | ||
(3)错误地修改循环变量吗? | 无 | ||
(4)存在误差累积吗? | 存在 | ||
重要 | 错误处理问题: | ||
(1)忘记进行错误处理吗? | 未 | ||
(2)错误处理程序块一直没有机会被运行? | 未 | ||
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 | 未 | ||
(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | 未 | ||
重要 | 文件I/O问题: | ||
(1)对不存在的或者错误的文件进行操作吗? | 未写入文件 | ||
(2)文件以不正确的方式打开吗? | |||
(3)文件结束判断不正确吗? | |||
(4)没有正确地关闭文件吗? |
从结构体开始分析,第一个结构体清楚地写明了运算符,与运算符的优先级,并用数组清楚地写明了左右运算符的优先级,但是运算符单独写出了一些常用的运算符,没写出一些不常用的运算符,使此计算器的功能有局限性。第二个结构体写入了函数里,影响了代码的工整性与清晰明了的特点。代码布局工整,每一行代码都实现一个功能,{}都是成对出现的,且If、for、while、do等语句自占一行,不论执行语句多少都要加 {}。循环方面没有出现多余的判断与赋值,每一步都有必要性。从赋值方面来看出现了int转float,float转int,double转float的情况,这点要十分的注意,从精确度高转精确度低的这种情况是不可以存在的,转换的过程中你要考虑是否对运算结果有一定的影响。从注释方面来看,部分函数的注释清晰明了,而有的函数却没有注释让人很难一眼就知道这个函数是做什么用的。注释在代码中是十分的重要的。从优先级的情况来看,很清楚的用括号来标清先要进行哪一步的运算。可以在代码中添加适当的空行,来区分每个功能块的作用。
队友的代码功能比较完善,考虑到除数为0的情况,还有括号的情况,并且每计算完一次,可以清楚结果进行下一次计算。但还有可以完善的地方,加入清零按键,与=按键,让计算的过程中可以查看此时运算的结果,再加入在结果的基础上继续计算的功能。还可以加入查询上一次计算结果的功能。这是我对功能的上的一些添加。
代码的复审是个很重要的环节,不仅仅是纠错的过程,还是完善功能的过程。