软工4——结对审查

结对审查

审查对象

结对者：代福琳

审查代码
https://coding.net/u/daifulin/p/four/git/blob/master/1.cpp?public=true

C++代码审查表

功能模块名称	猜拳游戏
审查人	王扶霖	审查日期	2018.04.05
代码名称	Gamer.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问题：（未使用文件）
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

## 分析 总计99项数据，其中对于结论的统计数据如下  其中多项审查规范并未涉及到，也归结为否中，所以“否”占了大多数。 ## 评价 ### 规模 这里的规模说的是代码的规模，也就是解决同样问题的程序包含的代码行数。如果单从这个因素讲，那一定是代码规模越小越好。但规模越小往往就会让代码本身的复杂程度变高，影响可读性。 ```C switch (gamer){ case 65: //A case 97: //a gamer=4; break; case 66: //B case 98: //b gamer=7; break; case 67: //C case 99: //c gamer=10; break; case 68: //D case 100: //d return 0; } ``` 这一段代码完成的工作很少，却占用了很多行，注释的过于频繁也影响了可读性。

执行效率

从某种意义上讲，如今对程序的第一要求应该就是执行效率。人们说的最多的就是执行效率和运行空间的关系，还有执行效率和可读性的关系。
队友的这段代码没有什么明显能浪费运行时间的操作，所以可以说执行效率对于其所完成的功能来说是很高的。

代码复用

最另程序员难受的就是程序中大量出现重复代码，用大量的重复的代码去完成变化很小的工作是很不值的，完全可以用代码复用思想去解决。
比如这段程序

    switch (computer)
    {
      case 0:printf("剪刀\n");break; //4  1
      case 1:printf("石头\n");break; //7 2
      case 2:printf("布\n");break;  //10 3
    }
    switch (gamer)
    {
      case 4:printf("剪刀\n");break;
      case 7:printf("石头\n");break;
      case 10:printf("布\n");break;
    }

相同的功能，只用写一个功能函数再执行调用就能很有效率的缩短代码行数。

void winner(int player){
  switch (player)
    {
      case 4:printf("剪刀\n");break;
      case 7:printf("石头\n");break;
      case 10:printf("布\n");break;
    }
}

不能牺牲可读性

底层程序员喜欢用位运算，于是常有人把简单的计算用位运算进行优化，比如把

a / 2;

改成

a >>1;

由于位运算的物理特性，下面这段代码的确效率会更高一些。不过，很多人看到这种写法都不一定能反应上来。
队友的程序里没有出现晦涩的表达。

空间占用

调配或动态分配的数组或指针等，在使用过后需要释放掉已防止之后的程序过度占用内存直至内存溢出或崩溃，幸运的是，队友的程序并没有涉及到这方面的运用，所以没有内存占用的问题。

可读性

对于越来越提倡代码规范的中国软件行业来说，可读性开始成为不可忽视的重要因素。无论是统一的代码风格，还是规范的命名、函数设计和注释，这些都必须注意。
队友的代码中注释很丰富，甚至是过于丰富了。代码整体的排版也符合C的规范。但有些地方对空间的利用却没有必要。
如这段

    if (result==6||result==7||result==11) printf("你赢了!");
    else if (result==5||result==9||result==10) printf("电脑赢了!");
    else printf("平手");

明显就没有这种易读

    if (result==6||result==7||result==11) {
		printf("你赢了!");
	}
    else if (result==5||result==9||result==10) {
		printf("电脑赢了!");
	}
    else {
		printf("平手");
	}

换行和空格都会在预编译中被抹去，所以这种牺牲可读性来可以减少代码行数的行为是不鼓励的。if或for后面接一行代码虽然不需要多余的大括号，但是在大型项目中这样会损失易读性，在查错时容易与其他函数分不清边界。

扩展性

对于一些大型的、生命周期久的项目而言，扩展性相当重要。但扩展性有一个死敌就是代码量。仔细研究一下经典的23种设计模式，没有哪一个不是成倍地提高了代码量。
在很多资深程序员中，还常常因为是否使用设计模式引发争论。而这些争论的焦点就是代码量和扩展性这对矛盾。究竟这二者孰轻孰重呢，其实也没有一定之规，完全取决于具体的项目情况。具体问题具体分析才是王道。
这里补充一点，不要为了扩展性而扩展，如同使用设计模式，不要为了设计模式而使用设计模式，自己把问题搞复杂了，程序维护起来会很麻烦。
队友的代码全程写在main函数中，这对于扩展性几乎是致命的。如果是长篇代码这么写的话，第二个人来就很难对其进行扩充，这对代码作者很可能也是个挑战。
由于这个程序功能不算复杂，队友可能为了涂方便才这么写了，但是还是不鼓励这种行为。毕竟面向对象是一种思想性的东西，还是在基础层面做起最好。

总结

评价就到此为止了，其中的评价方向参考了如何评价一段代码。总的来说这次结对作业让我了解了队友的代码习惯，也锻炼了具体的审查代码的能力，
当对审查规范有了大致映像后，相信在日后的程序编写中也能注意到这些问题并避免由于不规范的陋习产生的不可察觉的错误。