软件工程（2019）结对编程第一次作业

1.题目要求

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

2.代码地址

这个项目由张浩宇编写，他所选的是他的数据结构课设——带父节点的二叉平衡树,使用C++开发。

3.C++代码审查表

功能模块名称	带父节点的平衡二叉树
审查人	王宗波	审查日期	2019.4.22
代码名称	Balancing_Binary_Tree/源.cpp	代码作者	张浩宇
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	是
	头文件和定义文件的目录结构是否合理？	是
	版权和版本声明是否完整？	否
重要	头文件是否使用了 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.代码评价张浩宇同学这个代码，是使用C++开发的带父节点的二叉平衡树，最后也是在小黑框里画出了树的形状。由于他是我班的大佬，编程能力特别强，平时做事也很是认真，所以此次和他结对压力也是比较大。对于整个代码，真的是省心悦目，自我感觉是没一点问题，小到变量的定义大到函数的编写以及整个的风格代码都是非常完美，所以下面我就介绍一下他的代码的优点吧。 (1）变量的定义 ``` typedef int Status; typedef int KeyType;

typedef struct
{
KeyType key; //关键字域
}ElemType, TElemType;

typedef struct TriTNode
{
//结点结构
TElemType data; //数据域
TriTNode *lchild, *rchild; //孩子结点域
TriTNode *parent; //双亲域
int bf; //平衡因子
}TriTNode, *BiTree;

typedef struct DisplayInfo
{
int level;
int pos;
bool enter;
int spacenum;
}DisplayInfo;

&emsp;&emsp;上述代码中，每一个变量清晰可见，对于一些难懂的变量和指针都进行必要的注释，让读代码的人通俗易懂。而且对于整个代码所实现的功能有一个大致的把握。而且他在对变量进行定义是，都是用英文进行命名，这一点也是我需要学习的地方。我在之前的编写中，不会注意这些，而是定义一大堆，例如a,b,c,d之类的。这样虽说简洁，但是含义并不明朗，这是我需要改进的地方。
（2）代码的书写风格

void DisplayTree(BiTree T)
{
list Q;
list QI;
int screenwidth = 64;
int datawidth = 2;
DisplayInfo Info; //将插入队列的结点的打印信息
DisplayInfo preInfo; //队尾结点的打印信息
BiTree curT; //队列当前取出的结点
DisplayInfo curInfo; //队列当前取出结点的打印信息
if (!T)
{
cout << "此树为空树！" << endl;
return;
}
Q.push_back(T);
Info.level = 1;
Info.enter = true;
Info.spacenum = screenwidth >> Info.level;
Info.pos = Info.spacenum;
QI.push_back(Info);
preInfo = Info;
while (Q.size())
{
curT = Q.front();
Q.pop_front();
curInfo = QI.front();
if (curInfo.enter)
{
cout << endl << endl;
}
for (int i = 0; i < curInfo.spacenum; i++)
cout << " ";
cout << curT->data.key;
QI.pop_front();
if (curT->lchild)
{
Q.push_back(curT->lchild);
Info.level = curInfo.level + 1;
Info.pos = curInfo.pos - (screenwidth >> Info.level);
if (Info.level > preInfo.level)
{
Info.enter = true;
Info.spacenum = Info.pos;
}
else
{
Info.enter = false;
Info.spacenum = Info.pos - preInfo.pos;
}
Info.spacenum -= datawidth;
QI.push_back(Info);
preInfo = Info;
}
if (curT->rchild)
{
Q.push_back(curT->rchild);
Info.level = curInfo.level + 1;
Info.pos = curInfo.pos + (screenwidth >> Info.level);
if (Info.level > preInfo.level)
{
Info.enter = true;
Info.spacenum = Info.pos;
}
else
{
Info.enter = false;
Info.spacenum = Info.pos - preInfo.pos;
}
Info.spacenum -= datawidth;
QI.push_back(Info);
preInfo = Info;
}
}
cout << endl;
}

&emsp;&emsp;上述代码中，整整齐齐。从首行的对其到每一个括号的对应，这样不仅美观，而且让读他代码的人很容易理清之间的逻辑关系。如不规范就会有这个if不知道对应哪个else，很难一眼看出之间的联系也给阅读的人带来了巨大的困难。
（3）模块化设计

int main()
{
BiTree T = NULL;
BiTree P = NULL;
bool taller;
int num;
int key[100];
cout << "请输入要插入到AVL树的结点数：";
cin >> num;
for (int i = 0; i < num; i++)
{
cout << "请输入要插入的结点关键字数据：";
cin >> key[i];
InSertAVLTree(T, key[i], taller, P);
cout << "当前的AVL树为：" << endl;
DisplayTree(T);
}
cout << "最终的AVL树为：" << endl;
DisplayTree(T);
system("pause");
return 0;
}

&emsp;&emsp;从他的主函数可以看出，他写了许多模块化的功能函数。这样设计的好处在于思路清晰，整个项目的逻辑性强，每个功能之间有联系、嵌套之类，如有错误也很容易发现问题出在哪一个模块，避免了全写在一起而混杂的问题。
##5.总结
&emsp;&emsp;刚开始对于代码复审工作觉得没什么必要，我能实现功能就行，管他代码怎么样。但是做过之后发现我的这个思想是错误的，这不是一个繁杂的工作，而是一个有效的工作，带给我们的好处也不是一点半点的。通过一定规范化的代码有着它自己独特的魅力，我们通过这一点点小的积累，将来才能实现更大的进步。代码不止是写给自己的，而是要让别人也通俗易懂的。通过这次复审，也让我看到了自己与大佬的差距，自己的不足在哪里，自己需要改进的地方在哪里，也为自己今后需要奋斗的方向有一个明确的定位。

posted @ 2019-04-22 23:45 wangzongbo 阅读(187) 评论(0) 编辑收藏举报

刷新页面返回顶部

wangzongbo

软件工程（2019）结对编程第一次作业

1.题目要求

2.代码地址

3.C++代码审查表

公告