结对编程第一次作业

代码审查

一、C++ 代码审查表

参考博客:[c/c++代码审查]（https://blog.csdn.net/wenrenhua08/article/details/39591273） 结对编程伙伴：敖贵 代码地址：[Github] （https://github.com/AG2ZYR/demo/blob/master/%E8%88%9E%E4%BC%B4%E9%85%8D%E5%AF%B9.cpp ）

功能模块名称	舞伴配对
审查人	熊星	审查日期	2018.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问题：
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

##二、代码详论 * 该代码是来自于敖贵同学的数据结构课程设计，课程要求是用队列实现男女两组配对结成舞伴的配对方法。第一眼看到代码结构，就觉得特别简洁，可读性特别好，毫无多余之处。我们都知道，队列是一种特殊的线性表 ，它只允许在表的前端（front）进行删除操作，而在表的后端（rear）进行插入操作。进行插入操作的一端称为队尾，进行删除操作的一端称为队头。队列中没有元素时，称为空队列。
* 我觉得有必要对他的代码做一次部分展示，才能证明我说的话。

#include <stdlib.h>
#include <stdio.h>
#define MAX  100

typedef struct
{
    int *base;
    int front;
    int rear;
} SqQueue;

void InitQueue(SqQueue &Q)//初始化队列
{
    Q.base=(int*)malloc(MAX * sizeof(int));
    Q.front=Q.rear=0;
}

void EnQueue(SqQueue &Q,int e)//入队
{
    if((Q.rear+1) % MAX == Q.front)
    {
        exit(0);
    }
    Q.base[Q.rear]=e;
    Q.rear++;
}

void DeQueue(SqQueue &Q,int &e)//出队
{
    if(Q.front==Q.rear)
    {
        exit(0);
    }
    e=Q.base[Q.front];
    Q.front++;
}

void GetHead(SqQueue Q,int &e)//得到当前队列的头元素
{
    if(Q.front == Q.rear)
    {
        exit(0);
    }
    e=Q.base[Q.front];
}

• 由于其具有先进先出（FIFO）的特点，而经常被频繁地使用在各种场合，但是使用时要特别注意技巧。首先从敖贵这篇舞伴配对的C++程序中可以看出他已经完全的掌握 了队列的用法，并且在出队入队的时候都考虑到了出现空队列的情况 ，这样就不会产生溢出的后果，也就避免了许许多多的BUG，编程思维很是严谨。其次便讲讲这篇代码的排版，说实话，如果要我来写的话，我一定会写的比他差多了，相比之下我感觉我的“编程功力”还达不到如此 “如火纯青”的境界。通常说，一个好的程序员对待编程的态度就像对待自己儿子的态度一般，从还未动手之前你就要为“他”考虑周全（例如：变量声明的范围，变量的注释，子程序的结构，循环的嵌套使用，函数的嵌套使用等等），也即我们所说的“谋定而后动”策略，因为只有这样，你的代码才能更加perfect。相反的话，你现在偷的每一个懒，都是给未来挖的坑。最后从该程序的编程结构来看，想必编程者真的喜欢把代码简洁化，因为他的代码里面的main函数极其精简，主函数里面只有两个结构体声明语句以及一个子程序调用程序。

  int main()
    {
        SqQueue Q1;
        SqQueue Q2;
        Party(Q1,Q2);
        return 0;
    }

• 我就感觉他这样写main函数特别的简洁明了，没有一点冗余，让人读起来不会感觉繁琐生涩，他把主要的代码通过函数的形式互相嵌套在外面，避免了主函数里“一锅乱炖”的糟糕情况，故比较有层次感。虽然说该代码的代码量比较短，不易看出这种写法的优越性，但是等到要新建大工程的时候，如果你把所有的代码都放在main函数里的话，这种弊端就显而易见了。
  
  
• 最后讲讲该代码的不足之处，其在对队列进行入队和出队操作的子程序里面 ，没有特别用注释注明堆栈溢出的状况，而是直接用exit（0）；直接跳出结束程序，这样的话在出现溢出后你不清楚到底发生了什么就直接被强制退出了，让人不明所以。。。所以我觉得这里改成打印一行“队列已溢出”操作更加让人明白。

void EnQueue(SqQueue &Q,int e)//入队
{
    if((Q.rear+1) % MAX == Q.front)
    {
        exit(0);
    }
    Q.base[Q.rear]=e;
    Q.rear++;
}

• 还有就是函数在对结构体的进行引用的时候，要注明这是结构体的引用传递而不是一般的值传递，这样阅读者就更加能明白函数调用的来处和去处（人生三个的哲学终极问题即：你是谁？你从哪里来？你要往哪里去？）。  能完全搞清楚了这一点的人，离业界大神也就不远了。
  

##三、结语 * 通过审查队友的这篇代码，确实收益良多，以前总是以为自己做得不比别人差，现在想想真是太天真。从各方面的的比较让我明白了自身的缺点在哪。也正是通过这种比较和换位审查，让我的思维更加具有理性，同时也让我明白一点：代码标准会让团体之间的编程合作更加的契合。