结对编程初涉猎——结对伙伴的代码复审

至此为止，个人作业阶段就结束了，从此便进入团队合作阶段。这次是先从结对编程开始，虽然还没有进入正式的开发状态，但也是结对编程的小开端，同时也是一个复习代码复审这部分内容的过程。

阅读目录

题目要求

**要求：** (1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，建议尽量不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求； (2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行； (3). 将代码上传至**个人GitHub或Coding.net系统中**，并将代码地址交给对方； (4). 对同伴的作品进行代码复审，并参照[C/C++代码审查表](https://blog.csdn.net/wenrenhua08/article/details/39591273)和[Java代码审查表](https://blog.csdn.net/u012107806/article/details/50765580 ) 这两篇博文的内容自行设计代码审查表并填写内容； (5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的**GitHub**或**Coding.net**的代码地址； (6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。

结对体验

####**刚开始听说有结对编程项目的时候，我其实内心还挺想和班级里的男生一起组队的，因为很多男生的编程动手能力确实比大部分女生的动手能力要强（当然这里排除那些确实很厉害的女生），我想通过这个结对项目向男生吸取一些经验，多多学习一些他们的优势。**

但是下课后，我的室友，也就是我这次的结对编程小伙伴雷镓——一个性格豪放乐观又开朗的女生，向我抛出了橄榄枝，想让我作为我俩的领航者。其实在这里我也有考虑多方面因素，包括我们俩人的编程能力（确实还有点担心如果题目过于难，我们的实力到时候能否撑起这个编程项目，我能否把我们俩人的任务安排好等），但也有一些好处，我们俩是室友，编程时间可以随时规划，交流起来毫不费力等等......

所以，最后还是爽快地答应了，或许，两个女程序员能擦出更好的火花呢？

代码审查表

####**[雷镓同学的博客地址](http://www.cnblogs.com/leijia0329/)** ####**[雷镓同学的代码地址](https://coding.net/u/leijia0329/p/leijia004/git/blob/master/jiedui.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问题：
	（１）对不存在的或者错误的文件进行操作吗？	无
	（２）文件以不正确的方式打开吗？	无
	（３）文件结束判断不正确吗？	无
	（４）没有正确地关闭文件吗?	无

队友代码及优缺点评价

这次我就先来评价一下雷镓同学的代码吧，她的这次代码是她数据结构课程设计的代码，有关于最短路径的求解。其实我们俩的课程设计题目还是挺像的，我是用普里姆算法来求出以不同节点为起点构成的最小生成树，而她是用弗洛伊德算法求出连接两个城市的最短行走路线。

看她的代码之前就需要首先了解弗洛伊德算法，感觉又重新回到了大一大二学数据结构与算法的那个时期了，真的是好久都没有学过算法了，自我感叹自己根本不像是一个计算机专业的学生了。

其实雷同学的这个代码使用c语言写的，所以参照代码审查表中的一些c++的高级特性就没有什么意义了。她的这个小项目优点还是有很多的，比如算法写的比较完善，部分代码也还算比较整洁啊之类的，但是我认为还是有一些不可取的地方，在这里我就毫不客气地指出来啦。

1.从排版方面来看，
例如下面列举的她代码中的一个弗洛伊德函数，这块代码首先从排版上，我就看的比较难受，可能并不是只有我一个人强迫症吧，大括号{}在有的循环中出现了，在有的循环中没有出现。我个人的习惯是在一个函数中如果循环体中无论是有几条语句，哪怕只有一句也要加上大括号的这种强迫星人。

说实话为了看懂这段代码我确实真的是把它重新整理了一遍。

void Floyd(MGraph *L,int n)
{
int i,j,k;
for(i=1;i<=n;i++)
    for(j=1;j<=n;j++){
        if( L->arcs[i][j]!=Maxint)
            p[i][j]=j;
        else
            p[i][j]=0;
        D[i][j]=L->arcs[i][j];
    }
    for(k=1;k<=n;k++){
        for(i=1;i<=n;i++)
            for(j=1;j<=n;j++){
                if(D[i][k]+D[k][j]<D[i][j])  {
                    D[i][j]=D[i][k]+D[k][j];
                    p[i][j]=p[i][k];
                }
            }
    }
}

或许，改成这样是不是能看的方便一点呢，当然，这只是我的个人见解。

void Floyd(MGraph *L,int n)
{
int i,j,k;
for(i=1;i<=n;i++)
{
    for(j=1;j<=n;j++)
        {
            if( L->arcs[i][j]!=Maxint)
                p[i][j]=j;
            else
                p[i][j]=0;
        }
    D[i][j]=L->arcs[i][j];
}
for(k=1;k<=n;k++)
{
    for(i=1;i<=n;i++)
    {
        for(j=1;j<=n;j++)
        {
            if(D[i][k]+D[k][j]<D[i][j])  
            {
                D[i][j]=D[i][k]+D[k][j];
                p[i][j]=p[i][k];
            }
        }
    }

}
}

2.关于变量的定义
雷同学的部分代码变量定义的太过于简单，简单到我一眼看不出这是哪个变量...恩，其实我也是花费了一些时间来找。
比如说下面这两句

MGraph *L;
    int n,e,v,w,k;

不夸张地说，结合了后面的代码我也是看了好久才懂，我觉得我以前也是这样的，从大一开始学习c语言开始就一直用一些a、b、i、j、k、n之类的名字来定义变量。这其中有很多原因，其一是因为这些变量名字短，写起来方便，其二是自己写的程序都很短很简洁，哪怕定义10个20个这种变量自己也还是能记住每个字母都对应着什么意思，但是这就给别的阅读代码的人造成了困扰，如果是别人第一次阅读你的代码的话，我觉得他可能会崩溃。

我也是从大二开始写代码才想要用一些英文单词来命名变量，有些不会的就上网查英文意思，选一个比较符合函数意义的单词来命名。

在这里她定义的n为顶点个数，e为边数，v为起点，w为终点。如果我修改的话，可能会改为:

    int vertex ,edges ,start_point ,end_point ;

3.关于malloc
代码中使用了malloc来动态申请内存，以前我们编程的时候也没有注意到这样几个问题。
内存真的申请成功了吗？如果所申请的内存块大于目前堆上剩余内存块，则内存分配会失败，函数返回NULL。那我们在使用指向这块内存的指针时，必须用if（NULL！=p）语句来验证内存确实分配成功了。

申请成功之后，既然有分配，那就必须有释放。不然的话，有限的内存总会用光，而没有释放的内存却在空闲。与malloc对应的就是free函数了。free函数只有一个参数，就是所要释放的内存块的首地址。在这里雷镓同学并没有写相应的释放代码。

而既然使用free函数之后，指针变量本身保存的地址并没有改变，那我们就需要重新把p的值变为NULL。如果没有把指针置NULL，这个指针就成为了“野指针”，这是很危险的，而且也是经常出错的地方。所以free完之后，也一定要给指针置NULL。

这其实是一系列的内容，每次使用动态申请内存的时候都要考虑一些这些问题，这些也同样是我以前没有考虑到的。

4.有关注释
雷镓同学的代码没有注释，幸好她的代码不长，一百行多一点，而且函数只有三个，还都是无返回值的void函数，能从她的菜单中看出她的意图，还是挺好的，但是希望以后稍微写一些注释，有助于别人阅读她的代码。

个人感想

#### 首次结对编程体验虽然只是一个互相复审代码的过程，但还是让我有了很深刻的体会。结对编程？构建之法一书中说到结对编程是极限编程的一种，是比单人编程有很多可取之处的，其中一些优点就是两个人能够互相审查、共同进步。而我们写代码不能只自己看，自己偷偷藏着掖着自己随便写，以后也绝对是不可能的事情，一己之力做不成什么大项目。为了让别人能够容易阅读你的代码，首先代码所需要的就是简明，易读。代码复审的过程中才知道原来小伙伴的代码有很多优点，同时也暴露了很多缺点，而自己反观自己的代码，同样惨不忍睹，年轻啊，以为写代码是多么容易的事情，动动脑子，仔细研究研究算法就行了，事实根本不是这样，如果真正落实到实际项目之中，那要考虑的太多了。