软件工程第一次结对作业

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

功能模块名称	用kruskal算法求最小生成树各边的权值之和
审查人	张浩	审查日期	2019年4月24日
代码名称	用kruskal算法求最小生成树各边的权值之和	代码作者	王鹏
文件结构
重要性	审查项	结论
重要	头文件和定义文件的名称是否合理	是
	头文件和定义文件的目录结构是否合理	是
重要	版权和版本声明是否完整？	无
	头文件是否使用了ifndef/define/endif预处理块？	无
重要	头文件中是否只存放“声明”而不存放“定义”	否	定义了全局变量
程序的版式
重要性	审查项	结论
	空行是否得体？	是
	代码行内的空格是否得体？	是
	长行拆分是否得体？	是
	“{”和“}”是否各占一行并且对齐于同一列？	否	“{”跟随在上一语句之后
重要	一行代码是否只做一件事？如定义一个变量，只写一条语句	否	存在一行多个变量的问题
重要	if ,for,while,do等语句自占一行，不论执行语句多少都要加“{}”	否	多条语句才加“{}”
重要	在定义变量（或参数）时，是否将修饰符*和&紧靠变量名？注释是否清晰并且必要	否否否	基本没注释，看得老累了
重要	注释是否有错误或者可能导致误解？	是	基本没注释
重要	类结构的public，protected，private顺序是否在所有的程序中保持一致？	无
命名规则
重要性	审查项	结论
重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
	标识符是否直观且可以拼读？	是
	标识符的长度应当符合“min-length && max-information”原则？	是
重要	程序中是否出现相同的局部变量和全部变量？	是	i，j用了好几次
	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是	大小写区分
	静态变量、全局变量、类的成员变量是否加前缀？	是
表达式与基本语句
重要性	审查项	结论
重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	是
	是否编写太复杂或者多用途的复合表达式？	否
重要	是否将复合表达式与“真正的数学表达式”混淆？	否
重要	是否用隐含错误方式写if语句？例如
	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	无
	（2）将浮点变量用“==”或“！=”与任何数字比较。	否
	（3）将指针变量用“==”或“！=”与NULL比较。	否
	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？	否
重要	Case语句的结尾是否忘了加break？	无
重要	是否忘记了switch的fault分支？	否
重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	否	没有用goto
常量
重要性	审查项	结论
	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是	例如min，max
	在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。
其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（1）变量的数据类型有错误吗啊？	否
	（2）存在不同数据类型的赋值吗？	否
	（3）存在不同数据类型的比较吗？	否
重要	变量值问题：
	（1）变量的初始化或缺省值有错误吗？	否
	（2）变量发生上溢或下溢吗？	否
	（3）变量的精度够吗？	否
重要	逻辑判断问题：
	（1）由于精度原因导致比较无效吗？	否
	（2）表达式中的优先级有误吗？	否
	（3）逻辑判断的结果颠倒吗？	否
重要	循环问题：
	（1）循环条件不正确吗？	否
	（2）无法正常终止（死循环）吗？	否
	（3）错误地修改循环变量吗？	否
	（4）存在误差累积吗？	否
重要	错误处理问题：
	（1）忘记进行错误处理吗？	否
	（2）错误处理程序块一直没有机会呗运行吗？	否
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	否
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	否
重要	文件I/O问题：
	（１）对不存在的或者错误的文件进行操作吗？	无
	（２）文件以不正确的方式打开吗？	无
	（３）文件结束判断不正确吗？	无
	（４）没有正确地关闭文件吗?	无

4.代码分析与个人感受
   本次作业是要求两两一对，审查彼此的代码，刚开始我对这种方法表示不理解，一份代码，最了解和最懂它的肯定是它的编写人员，也就是程序员本身，让去看其他人的代码，既费时又费力，可当我仔细看完别人的代码后才深深的知道了两人代码复审的好处，通过观看别人的代码，你可以发现他许多的不足之处，而这些不好的地方恰恰可能我们自己也有，同时也会发现别人和我们不同的编程思路，有时候看着看着就发现，原来还可以这么做啊，以前都没想到。通过看别人的代码，让我收获良多。
   我这次作业复审的是王鹏同学的代码，代码是要求用kruskal算法求最小生成树各边的权值之和，kruskal算法即克鲁斯卡尔算法，指求加权连通图的最小生成树的算法。kruskal算法总共选择n- 1条边，所使用的贪婪准则是：从剩下的边中选择一条不会产生环路的具有最小耗费的边加入已选择的边的集合中。注意到所选取的边若产生环路则不可能形成一棵生成树。kruskal算法分e步，其中e是网络中边的数目。按耗费递增的顺序来考虑这e条边，每次考虑一条边。当考虑某条边时，若将其加入到已选边的集合中会出现环路，则将其抛弃，否则，将它选入。代码有许多做得很好的地方，值得去学习，但是也有一些做得不好的地方。
优点
（1）. 代码的有些变量定义规范，采用了较为容易理解的变量来命名。

int lowcost[100];
    int teend[100];
    int mincost;
    int length = 0;

（2）. 代码书写较为规范，空格和换行使用恰当。
（3）. 在编写代码之前特意将题目要求以注释的形式放在了代码内，便于阅读
缺点
（1）. “{}”使用不恰当，“{”总是放在代码的末尾，没有重写一行，不利于阅读。

for (i = 0; i < numV; i++)
        for (j = 0; j < numV; j++) {
            Graph[i][j] = INT_MAX;
        }
    for (i = 0; i < numE; i++) {

        scanf("%d%d%d", &a, &b, &c);
        Graph[a - 1][b - 1] = c;
        Graph[b - 1][a - 1] = c;

    }

（2）. 代码注释很少，不利于阅读，在刚开始阅读代码时无法快速理解代码含义。
（3）. 部分变量命名不规范，比如有几个变量直接以abc命名，看了半天才知道abc具体代表什么。
总结
以上他的代码中出现的一些问题我自己也有，比如命名不规范，经常性的命名变量abcde一大串，最后自己都不知道变量具体代表啥了，除此之外通过这次代码复审教会我最重要的就是一定要给代码加上注释，注释，尤其是一些比较难懂的代码，如果不加注释，当时可能是懂了，过几天以后回头再看发现又不懂了，所以加注释，既能方便自己查阅，也能方便他人很快的理解你的代码。

转载于:https://www.cnblogs.com/zhangwwy/p/10761702.html