软工结对编程代码审查

Posted 2020-10-29 洁癖Man

软工结对编程代码审查

结对编程代码审查

结对编程伙伴：刘博闻

审核程序GitHub地址：工资程序代码 

一：代码审查表

功能模块名称	工资程序
审查人	郭金鑫	审查日期	2018.04.05
代码名称	工资程序	代码作者	刘博闻
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	合理
	头文件和定义文件的目录结构是否合理？	合理
	版权和版本声明是否完整？	完整
重要	头文件是否使用了 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问题：（未使用文件）
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

 代码：

  1 /*************************************************************************
  2     > File Name: 工资程序.cpp
  3     > Author: 
  4     > Mail: 
  5     > Created Time: 2018年04月06日 星期五 10时07分53秒
  6  ************************************************************************/
  7 
  8 #include <iostream>
  9 // 为了读写文件，引入文件流对象头文件
 10 #include <fstream>
 11 #include <string>
 12 #include <climits> // 为了使用int类型的最大值和最小值
 13 
 14 using namespace std; 
 15 
 16 // 全局的工资数据文件名，使用一个不可修改的常量字符串表示
 17 const string strFileName = "SalaryData.txt";
 18 
 19 // 从数据文件读取工资数据到arrSalary数组
 20 int Read(int* arrSalary, int nCount)
 21 {
 22     int i = 0;   // 当前工资序号
 23 
 24     // 打开工资数据文件SalaryData.txt用于读入数据
 25     // 这个文件应该在exe文件所在的相同目录下
 26     ifstream in(strFileName);
 27 
 28     if(in.is_open()) // 如果成功打开数据文件
 29     {
 30          // 构造一个while循环读取文件中的工资数据
 31          // 如果读取的数据个数i小于数组的容量nCount，则继续读取
 32         while(i < nCount)
 33         {
 34              // 将读取的数据保存到arrSalary[i]
 35              in>>arrSalary[i];
 36              // 对读取结果进行判断，看是否读取到了文件结束
 37              // 如果到达文件结尾，则用break关键字结束读取循环
 38              if(!(in))
 39              {
 40                  break;
 41               }
 42 
 43              ++i;  // 尚未读取完毕，开始下一次读取
 44         }
 45 
 46         // 读取完毕，关闭文件
 47          in.close();
 48     }
 49     // 输出读取结果，返回读取的数据个数
 50     cout<<"读取"<<i<<"个工资数据"<<endl;
 51     return i;
 52 }
 53 
 54 // 将arrSalary数组中的工资数据写入数据文件
 55 void Write(int* arrSalary, int nCount)
 56 {
 57     // 创建或打开工资数据文件SalaryData.txt用于输出
 58     // 输出完成后，这个文件将出现在exe文件所在的目录
 59     ofstream o(strFileName);
 60     if(o.is_open()) // 如果成功打开数据文件
 61     {
 62         // 利用for循环，将数组中的数据输出到文件
 63          for(int i = 0;i < nCount;++i)
 64         {
 65              o<<arrSalary[i]<<endl; // 每一行一个数据
 66         }
 67 
 68         // 输出完毕，关闭文件
 69         o.close();
 70     }
 71 }
 72 
 73 // 获取工资数组中的最大值
 74 int GetMax(int* arrSalary, int nCount)
 75 {
 76     int nMax = INT_MIN; // 初始值为int类型的最小值
 77     // 利用for循环遍历数组中所有数据元素，逐个进行比较
 78     for(int i = 0;i < nCount; ++i)
 79     {
 80         if(arrSalary[i] > nMax)
 81              nMax = arrSalary[i];
 82     }
 83     // 返回找到的最大值
 84     return nMax;
 85 }
 86 
 87 // 获取数组中的最小值（请依最大值函数的葫芦自行画出最小值函数的瓢）…
 88 
 89 // 计算数组中所有数据的平均值
 90 float GetAver(int* arrSalary, int nCount)
 91 {
 92     // 计算总和
 93     int nTotal = 0;
 94     for(int i = 0;i < nCount; ++i)
 95     {
 96         nTotal += arrSalary[i];
 97     }
 98  
 99     // 计算平均值并返回
100     if(0 != nCount) // 判断总数是否为0
101         return (float)nTotal/nCount;
102     else
103         return 0.0f; // 特殊情况返回0
104 }
105 
106 // 手工输入数据
107 int Input(int* arrSalary, // 工资数组首地址
108        int nMax,    // 数组能够容纳的数据的个数      //    
109        int nIndex)  // 数组中已有的数据的个数
110 {
111     // 用数组中已有数据的个数作为输入的起点
112     int i = nIndex;  // 在for循环之前初始化i，应为i在for循环之后还需要用到
113     for(; i < nMax; ++i) // i已经初始化，初始化语句留空
114     {
115         // 提示输入
116         cout<<"请输入"<<i<<"号员工的工资（-1表示输入结束）："<<endl;
117         // 将输入的数据保存到数组的arrSalary[i]数据元素
118         int n = 0;
119         cin>>n;
120         // 检查输入是否合法
121          if(cin)
122         {
123              arrSalary[i] = n;
124         }
125         else// 如果输入不合法，例如输入了英文字符，则提示用户重新输入
126         {
127              cout<<"输入错误，请重新输入"<<endl;
128              // 清理cin的输入标志位以重新输入
129              cin.clear();
130              // 清空输入缓冲区
131              cin.sync();
132              --i;  // 将输入序号退后一个
133              continue; // 直接开始下一次循环
134         }
135   
136         // 检查是否输入结束
137         if(-1 == arrSalary[i])
138         {
139              break; // 结束输入循环
140         }
141     }
142    
143     // 返回当前数组中共有的数据个数
144     return i;
145 }
146 
147 // 查询工资数据
148 void Find(int* arrSalary,int nCount)
149 {
150     while(true)  // 构造无限循环进行工资查询
151     {
152         int n = 0;
153         // 提示用户输入要查询的员工序号
154         cout<<"请输入要查询的员工序号（0-"<<nCount-1
155              <<"，-1表示结束查询）："<<endl;
156         // 获取用户输入的员工序号并保存到n
157         cin>>n;
158   
159         // 对用户输入进行检查
160         if(!cin) // 如果用户输入不合法
161         {
162              cout<<"输入错误，请重新输入"<<endl;
163              // 清理cin的输入标志位以重新输入
164              cin.clear();
165              // 清空输入缓冲区
166              cin.sync();
167              continue; // 开始下一次查询
168         }
169         else if(-1 == n) // 检查查询是否结束
170         {
171              // 查询结束，用break结束循环
172              cout<<"查询完毕，感谢使用！"<<endl;
173              break;
174         }
175         else if(n<0||n>=nCount) // 检查输入是否超出序号范围
176         {
177              // 输入序号超出范围，用continue开始下一次循环
178              cout<<"输入的序号"<<n<<"超出了序号范围0-"
179               <<nCount-1<<"，请重新输入。"<<endl;
180              // 开始下一次查询
181              continue;
182         }
183  
184         // 输入合法，输出用户查询的员工工资
185         cout<<"员工序号："<<n<<endl;
186         cout<<"员工工资："<<arrSalary[n]<<endl;
187     }
188 }
189 
190 int main()
191 {
192     // 定义保存员工数据的超大数组
193     const int MAX = 100000; 
194     int arrSalary[MAX] = {0};
195  
196     // 首先从数据文件读取已经保存的数据
197     int nCount = Read(arrSalary,MAX);
198     // 然后用手工继续输入工资数据
199     nCount = Input(arrSalary,MAX,nCount);
200 
201     // 对输入的工资数据进行统计
202     cout<<"输入完毕。一共有"<<nCount<<"个工资数据"<<endl;
203     cout<<"最大值："<<GetMax(arrSalary,nCount)<<endl;
204     cout<<"平均值："<<GetAver(arrSalary,nCount)<<endl;
205 
206     // 对工资数据进行查询
207     Find(arrSalary,nCount);
208     
209     // 查询结束，将工资数据保存到数据文件，以备下次使用
210     Write(arrSalary,nCount);
211   
212     return 0;
213 }

 

二：评价及总结

      在仔细运行并审查刘博闻同学的代码后，大概了解到他是将程序大致分成了手工输入、文件输入、获取最大值、获取平均值等多个模块，然后利用函数一一实现。程序可以选择手工输入工资数据或读取以前的数据然后进行添加信息和信息查找，并有求工资的最大值平均值等功能。在进行员工工资资料查找时，进行了对输入的检查并给予提示，防止了输入错误从而导致程序出错的问题的发生。界面用户体验很好，并且代码都加了详尽的注释，很是细心，代码书写规范整体看起来简洁明了。

      通过这次代码审查，我知道了我在书写程序时还有很多的不规范的地方，还有很多遗漏的会导致程序出错的一些小问题。以后要养成写注释的习惯，不仅是自己看，要使你的伙伴也能很清晰直观的了解你的代码的用途和原理，才能在以后的工作中获得更好的合作。