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

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

阅读目录

1.题目要求

2.结对体验

3.代码审查表

4.队友代码及优缺点评价

5.个人感想

题目要求

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

结对体验

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

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

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

代码审查表

雷镓同学的博客地址

雷镓同学的代码地址

代码审查表如下：

队友代码及优缺点评价

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

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

其实雷同学的这个代码使用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函数，能从她的菜单中看出她的意图，还是挺好的，但是希望以后稍微写一些注释，有助于别人阅读她的代码。

个人感想

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

??还想了想，以后如果在公司实习或者工作，遇到的同事和伙伴看不懂你的代码，那会是多么尴尬的一件事情，这首先就证明了你写的并不是很尽如人意，不是那么通俗易懂。缺点在代码复审中暴露出来了，下次真正做项目的时候要好好注意了。