代码复审---结对复查
1.题目要求
(1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，建议尽量不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
(2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
(3). 将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
(4). 对同伴的作品进行代码复审，并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容；
(5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
(6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
2.简要介绍
我们可以发现代码复查的优点显而易见。首先，通过对代码风格与规范的审查，可以大大提高代码的可读性与可维护性。现在的软件，往往需要持续的维护与升级，人员变动也在所难免，因此代码的可读性与可维护性尤为重要。代码复查是一种鞭策，因为它的存在，督促着开发人员自觉地规范编码，养成好的编码习惯，提高代码质量。一个值得注意的问题是，如果你不去读别人的代码，永远不能深刻理解什么是可读的代码，而自己的代码不让别人去读并且反馈，也永远不知道自己的代码是否可读，即使你是一个编码多年的老手。代码复查恰恰解决了这个问题，值得你去尝试。
其次，代码复查是一次程序员之间的交流。新手可以有更多的机会向老手学习和指导，提高自身的设计水平（应当说这对于他们是非常宝贵的）；老手通过对新手的指导，整理和升华自己的设计思路与理论，同时也是对自己另一方面的锻炼与提高。另外，当你发现并指出了别人的一个问题以后，同时也是在警示自己不要犯同样的错误，这对审查与被审查者都是有益的。
3.审查表
接下来通过一份代码审查表对结对小伙伴的代码有个初步的总体上的了解，通过这份-参考林锐高质量C/C++审查表，对代码常见错误和格式要求对小伙伴的代码进行评价。
| 功能模块名称 | 简单的语法分析 | ||
| 审查人 | 刘科宏 | 审查日期 | 20184.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问题： | 无文件操作 | |
| （１）对不存在的或者错误的文件进行操作吗？ | 无 | ||
| （２）文件以不正确的方式打开吗？ | 无 | ||
| （３）文件结束判断不正确吗？ | 无 | ||
| （４）没有正确地关闭文件吗? | 无 | ||
https://coding.net/u/xinjj/p/sizeyunsuan/git/tree/master/?public=true
如果不想跳转的话这里会直接给出源代码，不长，100行左右
#include <iostream>
#include<time.h>
#include<cstdlib>
#define PERCENT 55
using namespace std;
#define random(x)(rand()%x)
typedef struct{ //定义栈
float *top; //指针 指向地址
float *base;
}sqstack ;
sqstack symbol,data;
void initstack(sqstack &s){ //初始化栈
s.base=(float *)malloc(sizeof(float)*20); //base 开辟空间
*s.base=6; //指向base 指针所指向的内容内容
s.top=s.base+1;
}
float gettop(sqstack &s){ //获取栈顶元素
if(s.top==s.base){
return 0;
cout<<"empty"<<endl;
}
return *(s.top-1);
}
void push(sqstack &s,float elem){ //压栈
*s.top=elem;
s.top++;
}
float pop(sqstack &s,float &elem){ //弹栈 并把弹出的值用elem返回
if(s.top==s.base){
return 0;
cout<<"empty"<<endl;
}
elem=*(s.top-1);
s.top--;
}
int priority(int a, int b){ //构造算符优先级表
int table[7][7]={1,1,-1,-1,-1,1,1,
1,1,-1,-1,-1,1,1,
1,1,1,1,-1,1,1,
1,1,1,1,-1,1,1,
-1,-1,-1,-1,-1,0,-2,
1,1,1,1,-2,1,1,
-1,-1,-1,-1,-1,-2,0};
return table[a][b]; //输入的a,b 依靠x，y在table 中找到相应的值
}
float handle(float *num11,char *symbol2 ){ //判断式子的正负
int ss[5];
for(int i=0;i<4;i++){ //把字符表里的元素换成数字
switch(symbol2[i]){
case '+':ss[i]=0;break;
case '-':ss[i]=1;break;
case '*':ss[i]=2;break;
case '/':ss[i]=3;break;
}
ss[4]=6;
}
initstack(symbol);
initstack(data);
push(data,num11[0]); //第一个数字入栈
for(int i=0;;)
{
if(priority(gettop(symbol),ss[i])==1) //栈外元素优先级比栈内低 出栈运算
{
float a,b;
float c;
pop(data,a); //出 两个数
pop(data,b);
pop(symbol,c);//出 符号
// push(symbol,ss[i]);
switch((int)c){
case 0:push(data,a+b);break;
case 1:push(data,b-a);break;
case 2:push(data,a*b);break;
case 3:push(data,b/a);break;
}
}
else if(priority(gettop(symbol),ss[i])==0) //若符号栈的最后一个元素和数据栈的元素一样 循环结束 返回data栈的栈顶元素
{return gettop(data);}
else {
push(symbol,ss[i]); //栈外元素优先级比栈内高 运算数入栈
push(data,num11[i+1]);
i++;}
}
}
int main()
{
/*float num[5]={1,2,0,4,5};
char num22[5]={'-','*','+','*'};
cout<<handle(num,num22)<<endl;
*/
char symbol1[4]={'+','-','*','/'};
char symbol2[4];
float num1[20],num2[20];
int i,j;
srand(time(0));
int flag=0; //flag 判断输出的个数i 若式子的值为负数i--
for( i=0;i<30;i++)
{
flag=0;
for( j=0;j<5;j++) {
if(random(PERCENT)==1) //判断生成分数 PERCENT 用来控制生成负数的概率 1/PERCENT
{
num2[j]=1+(float)random(100); //加1 保证生成的随机数不为0 做分子
num2[j+1]=num2[j]+(float)random(100); //分母 切分数为真分数
num1[j]=num2[j]/num2[j+1];
}
else num1[j]=(float)random(100); //生成整数
symbol2[j]=symbol1[rand()%4]; //随机生成符号
}
for(j=0;j<5;j++)
{
if(handle(num2,symbol2)>=0) //若生成的式子值为正数 输出
{if(j==0)
cout<<i+1<<": ";
if(num1[j]>0&&num1[j]<1) //若要输出的数为分数 就输出相应的分数
cout<<"("<<num2[j]<<"/"<<num2[j]<<") ";
else cout<<num1[j]<<" ";
if(j!=4)
cout<< symbol2[j]<<" ";
}
else flag=1;
}
if(flag==1) //
{
i--;
continue;
}
cout<<endl;
}
}
5.复查评论·互相进步
首先，我们可以看见，辛同学对栈的操作处理用了几个函数来进行，这些函数名也正对应着正确操作的含义，即做到函数名的规范性。这使代码阅读起来更易流利，而无需再去猜测这里调用的函数的功能，但也有不尽人意的地方，如函数handle，其名过去笼统，无法明确其确定功能。其次，就是函数入口参数顺序也是严格由重要到次要，从范围大到范围小来排序，这对多参数的函数阅读起来十分重要。
然后，在讨论一下格式排版问题。先讲一下，对二维数组的赋初值，辛同学对其进行了换行处理，使代码中行列排序对应着逻辑上二维数组格式。这便很令阅读代码的人轻松，不用再从一长串的初值中去辨认第几行第几列的元素值了。
然后再是代码中括号”{ }“格式的问题了，之前我和辛同学说过这个问题，但她却不以为然，还说我强迫症~~，╮(╯﹏╰）╭（无奈摊手状）。确实，括号的列对齐，对分析代码功能十分重要。循环判断，条件判断，函数区域以及定义的变量的作用域都是来依靠括号来分界，程序代码都是由这些组成的，所以如果！，如果不进行列对齐，就让代码阅读者很头疼，炸裂式地疼。同时还存在的类似的其他问题，如，case语句不对齐，同一条件下功能级别的语句不对齐.......,这也许能算些许的强迫症吧，但是，我们再想想。对齐与否，应该形象地表示为，缩进的决定缩进的更多地的语句。使代码根据功能性的结构化。这里也再反思自己的习惯，有时自己也做不到这些，因为没想过给别人看自己的代码，所以任由着自己的感觉来写。嗯，这样是不对的。
最后，我们共同的问题，C与C++关于内存申请的问题。既然选择using namespace std，但我们还是会经常使用C的内存管理函数来申请空间，这有点像cout和printf同时出现在同一段代码中一样。但不得不承认，结合起来是比单一的表达方式更方便一点......再说一说我俩都存在的问题，关于申请空间后从未考虑释放空间。可能是第一次发现写不写释放空间语句没有影响时，以后就索性不写了。直到最近查找一个Bug时，废了九牛二虎之力才找到一个指针未被释放而越权使用了。Emmmm，以后会一定重视这个问题的！
