C++代码审查
C++代码审查
1. 目的与要求
- 寻找结对编程伙伴，并练习结对编程；
- 对同伴的作品进行代码复审，设计审查表并填写；
- 评价同伴的代码，介绍同伴的优缺点。
2. 复审代码
小伙伴李宏达的项目代码与博客地址
项目代码实现功能
对随机生成的两个整型数组使用快速排序算法升序排序，并进行合并，同时使用快速排序对合并后数据升序排序。
- 源代码
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#define MAX1 10 //定义数组1个数
#define MAX2 10 //定义数组2个数
#define SWAP(x,y) {int t; t = x; x = y; y = t;}//两数交换
//函数声明
int partition(int[], int, int);
void quicksort(int[], int, int);
void mergesort(int[], int, int[], int, int[]);
int main(void)
{
//两个数组置零
int number1[MAX1] = {0};
int number2[MAX1] = {0};
int number3[MAX1+MAX2] = {0};
int i;
srand(time(NULL));//产生随机数种子
printf("排序前：");
printf("\nnumber1[]：");
for(i = 0; i < MAX1; i++)
{
number1[i] = rand() % 100;
printf("%d ", number1[i]);
}
printf("\nnumber2[]：");
for(i = 0; i < MAX2; i++)
{
number2[i] = rand() % 100;
printf("%d ", number2[i]);
}
// 先排序两列数组
quicksort(number1, 0, MAX1-1);
quicksort(number2, 0, MAX2-1);
printf("\n排序后：");
printf("\nnumber1[]：");
for(i = 0; i < MAX1; i++)
printf("%d ", number1[i]);
printf("\nnumber2[]：");
for(i = 0; i < MAX2; i++)
printf("%d ", number2[i]);
// 合并排序
mergesort(number1, MAX1, number2, MAX2, number3);
printf("\n合并后：");
for(i = 0; i < MAX1+MAX2; i++)
printf("%d ", number3[i]);
printf("\n");
return 0;
}
//快速排序
int partition(int number[], int left, int right)
{
int i;
int j;
int s;
s = number[right];
i = left - 1;
for(j = left; j < right; j++)
{
if(number[j] <= s)//将数组先进行排序，分割点为整体正确排序点
{
i++;
SWAP(number[i], number[j]);
}
}
SWAP(number[i+1], number[right]);
return i+1;
}
//递归快速排序
void quicksort(int number[], int left, int right)
{
int q;
if(left < right)
{
q = partition(number, left, right);
//将剩下的数组进行快速排序
quicksort(number, left, q-1);
quicksort(number, q+1, right);
}
}
//将两行排序好的数组进行合并
void mergesort(int number1[], int M, int number2[], int N, int number3[])
{
int i = 0;
int j = 0;
int k = 0;
while(i < M && j < N)
{
if(number1[i] <= number2[j])
number3[k++] = number1[i++];
else
number3[k++] = number2[j++];
}
while(i < M)
number3[k++] = number1[i++];
while(j < N)
number3[k++] = number2[j++];
}
3. 代码审查表设计与填写
| 功能模块名称 | 数组合并-快速排序 | ||
| 审查人 | 李鑫 | 审查日期 | 2019 - 04 -23 |
| 代码名称 | 数组合并-快速排序 | 代码作者 | 李宏达 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 否 | ||
| 重要 | 头文件是否使用了 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问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 否 | ||
4. 评价
4.1 代码存在的问题
通过对照审查表对代码进行审查，我发现了如下问题：
- 变量、函数命名未严格遵循代码规范。函数命名未使用匈牙利法，部分变量命名无法直接知晓作用与意义；
- 部分循环、判断语句未严格使用
{}界定范围；
如此部分修改前：
修改后：
- 未对程序进行错误处理；
- 未适当的对程序的整体功能进行说明。
4.2 优点
部分优点如下：
- 代码模块扩展性好，合并数组、快速排序可在他处直接使用；
- 代码格式排版清晰整洁，空格、换行使用得当；
- 注释添加合理，能快速明白程序功能；
- 能合理的使用
宏定义对常量或简单函数定义； - 代码模块化，合理去耦合；
- 代码功能完备，能正确的满足需求。
在依照审查表审查了李宏达同学的代码之后，我找到了一些大家都十分容易忽略的不足点，如单行语句的{}添加问题、困扰大家许久的变量与函数的命名问题、注释的合理添加以及必要的错误处理等等。我们编写代码的时候往往是实现题目所给的要求即停止，缺少必要的错误处理，这是十分不可取的。在审查同伴的代码时我也发现自己同样在犯这些毛病，可以看出代码复审这件事情是非常重要的，它能让我们发现他人的不足的同时也发现自己的问题，能同时促进双方的进步。
当然李宏达同学对代码的编写是十分认真的，代码格式排版整洁、各部分功能明确、输出有合理的提示也能为代码添加详细的注释，若能将变量的命名规范化些就非常好了。代码中的所有变量都进行了赋初值操作，可以说是十分细心了。此外，李宏达同学对所有的函数都遵循先声明后定义、使用的准则，看程序时使人一目了然，十分友好。代码虽然短小简单，但是李宏达同学完成的十分认真，遵守了大部分Code Style 规范，完成情况很好。
这只是结对编程的一次小试牛刀，希望在以后的合作中我俩能相互帮助，共同提升自身的水平。
参考资料：C++代码审查表
