软工结对编程代码审查

结对编程代码审查

结对编程伙伴：刘博闻

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

一：代码审查表

代码：

  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 }

二：评价及总结

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

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

原文地址：https://www.cnblogs.com/GJIN/p/8725276.html