一、伙伴代码
在线商城商品
二、代码审查表
序号 |
重要性 |
审查项 |
结论 |
1 |
不重要 |
头文件和定义文件的名称是否合理? |
是 |
2 |
不重要 |
头文件和定义文件的目录结构是否合理? |
是 |
3 |
不重要 |
版权和版本声明是否完整? |
无 |
4 |
重要 |
头文件是否使用了 ifndef/define/endif 预处理块? |
无 |
5 |
不重要 |
头文件中是否只存放“声明”而不存放“定义” |
是 |
6 |
不重要 |
空行是否得体 |
是 |
7 |
不重要 |
代码行内的空格是否得体? |
是 |
8 |
不重要 |
长行拆分是否得体? |
无 |
9 |
不重要 |
“{” 和 “}” 是否各占一行并且对齐于同一列? |
是 |
10 |
重要 |
一行代码是否只做一件事?如只定义一个变量,只写一条语句 |
是 |
11 |
重要 |
If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 |
是 |
12 |
重要 |
在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? |
是 |
13 |
重要 |
注释是否有错误或者可能导致误解? |
是 |
14 |
重要 |
类结构的public, protected, private顺序是否在所有的程序中保持一致? |
是 |
15 |
重要 |
命名规则是否与所采用的操作系统或开发工具的风格保持一致? |
是 |
16 |
不重要 |
标识符是否直观且可以拼读? |
是 |
17 |
不重要 |
标识符的长度应当符合“min-length && max-information”原则? |
是 |
18 |
重要 |
程序中是否出现相同的局部变量和全部变量? |
是 |
19 |
不重要 |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? |
是 |
20 |
不重要 |
静态变量、全局变量、类的成员变量是否加前缀? |
否 |
21 |
重要 |
如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? |
无 |
22 |
不重要 |
是否编写太复杂或者多用途的复合表达式? |
否 |
23 |
重要 |
是否将复合表达式与“真正的数学表达式”混淆? |
否 |
24 |
重要 |
是否用隐含错误的方式写if语句? |
是 |
25 |
重要 |
Case语句的结尾是否忘了加break? |
是 |
26 |
重要 |
是否忘记写switch的default分支? |
是 |
27 |
重要 |
使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 |
无 |
28 |
不重要 |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? |
是 |
29 |
不重要 |
在C++ 程序中,是否用const常量取代宏常量? |
无 |
30 |
重要 |
如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? |
是 |
31 |
不重要 |
是否误解了类中的const数据成员? |
无 |
32 |
不重要 |
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 |
是 |
33 |
不重要 |
参数命名、顺序是否合理? |
是 |
34 |
不重要 |
参数的个数是否太多? |
是 |
35 |
不重要 |
是否使用类型和数目不确定的参数? |
是 |
36 |
不重要 |
是否省略了函数返回值的类型? |
是 |
37 |
不重要 |
函数名字与返回值类型在语义上是否冲突? |
是 |
38 |
重要 |
是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 |
否 |
39 |
重要 |
在函数体的“入口处”,是否用assert对参数的有效性进行检查? |
否 |
40 |
重要 |
使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 |
无 |
41 |
重要 |
return语句是否返回指向“栈内存”的“指针”或者“引用”? |
是 |
42 |
不重要 |
是否使用const提高函数的健壮性 |
否 |
43 |
重要 |
用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存) |
无 |
44 |
重要 |
是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) |
是 |
45 |
重要 |
数组或指针的下标是否越界? |
是 |
46 |
重要 |
动态内存的申请与释放是否配对?(防止内存泄漏) |
无 |
47 |
重要 |
是否有效地处理了“内存耗尽”问题? |
无 |
48 |
重要 |
是否修改“指向常量的指针”的内容? |
无 |
49 |
重要 |
是否出现野指针? |
无 |
50 |
重要 |
是否将malloc/free 和 new/delete 混淆使用? |
无 |
51 |
重要 |
malloc语句是否正确无误?例如字节数是否正确?类型转换是否正确? |
无 |
52 |
重要 |
在创建与释放动态对象数组时,new/delete的语句是否正确无误? |
无 |
53 |
不重要 |
重载函数是否有二义性? |
无 |
54 |
重要 |
是否混淆了成员函数的重载、覆盖与隐藏? |
无 |
55 |
不重要 |
运算符的重载是否符合制定的编程规范? |
是 |
56 |
不重要 |
是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。 |
是 |
57 |
重要 |
是否用内联函数取代了宏代码? |
无 |
58 |
重要 |
是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数: |
是 |
59 |
重要 |
构造函数中是否遗漏了某些初始化工作? |
是 |
60 |
重要 |
是否正确地使用构造函数的初始化表? |
无 |
61 |
重要 |
析构函数中是否遗漏了某些清除工作? |
是 |
62 |
不重要 |
是否错写、错用了拷贝构造函数和赋值函数? |
是 |
63 |
重要 |
赋值函数一般分四个步骤,是否遗漏了重要步骤 |
无 |
64 |
重要 |
是否正确地编写了派生类的构造函数、析构函数、赋值函数? |
是 |
65 |
重要 |
是否违背了继承和组合的规则? |
是 |
66 |
重要 |
数据类型问题: |
是 |
67 |
重要 |
变量值问题: |
是 |
68 |
重要 |
逻辑判断问题: |
是 |
69 |
重要 |
循环问题 |
是 |
70 |
重要 |
错误处理问题 |
是 |
71 |
重要 |
文件I/O问题: |
是 |
三、评论
伙伴这个的代码,做了一个在线商城商品管理系统,代码行数470多行,工作量很大,细节问题也注意的很好,用户界面做的很美观,哈哈,比我的美观,而且每次操作完可以继续使用,不用重新运行程序,C++类的知识用的也很好,提取了商品的共性信息,巧妙的运用了类的继承,也没有混淆继承和组合问题,我觉得相对而言还是比较完美的,审查了70多项也没有发现什么重大的问题,对于变量的命名问题做的也很规范,当时我的课设,自认为做的也可以,但是并没有意识到命名规范的问题。不过他这个对于数组的操作吧,我觉得可以动态分配一下,这样的话程序比较灵活,可以节省较多的内存空间,对于有些代码量较大的函数操作,我觉得可以定义为内联函数,C++中支持内联函数,其目的是为了提高函数的执行效率,用关键字 inline 放在函数定义(注意是定义而非声明)的前面即可将函数指定为内联函数,内联函数通常就是将它在程序中的每个调用点上“内联地”展开,关键字 inline 必须与函数定义体放在一起才能使函数成为内联,仅将 inline 放在函数声明前面不起任何作用。具体可以看内联函数这篇博文,这个类的继承,我觉得这几个类看起来特别舒服,干净,很久没有写类似的代码了,很喜欢,看来类的优点还是蛮多的,这个同伴把类用的很好,代码写的很漂亮。
以上是我的一点感想和建议,希望合作愉快,互相提高,共同进步!