结对编程作业

1. 题目要求

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

代码链接:https://github.com/vbngfh123456/ruangon4/blob/master/LICENSE.md/code.cpp

2. 代码复审

| 功能模块名称
| :-------------------😐:------------------|:-------------------|-------------------😐
| 审查人 | 张天齐| 审查日期 |20180406|
|代码名称 | 哈希表 | 代码作者 | 冯玉正
|文件结构
|重要性 |审查项 |结论||
| |头文件和定义文件的名称是否合理?| 是|
| |头文件和定义文件的目录结构是否合理?|是|
| |版权和版本声明是否完整?|否|
|重要 |头文件是否使用了 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 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 |否|
|函数设计
|重要性| 审查项 | 结论||
|  |参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。|否|  
|  |参数命名、顺序是否合理?  |否|
|  |参数的个数是否太多?  |是|
|  |是否使用类型和数目不确定的参数? |是| 
|  |是否省略了函数返回值的类型? |是| 
|  |函数名字与返回值类型在语义上是否冲突?  |否|
|重要 |是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。  |否|
|重要 |在函数体的“入口处”,是否用assert对参数的有效性进行检查?  |否|
|重要 |使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。  |否|
|重要 |return语句是否返回指向“栈内存”的“指针”或者“引用”?  |否|
||  是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need”|否|
|其它常见问题
|重要性 |审查项 | 结论|
|重要 |数据类型问题:||  
|  (1)变量的数据类型有错误吗?  |否|
 |(2)存在不同数据类型的赋值吗? |否| 
  |(3)存在不同数据类型的比较吗? |否| 
|重要 | 变量值问题: || 
  |(1)变量的初始化或缺省值有错误吗? |否| 
  |(2)变量发生上溢或下溢吗?  |否|
  |(3)变量的精度够吗? |否| 
|重要| 逻辑判断问题:  
| (1)由于精度原因导致比较无效吗? |否| 
 | (2)表达式中的优先级有误吗?  |是| 
  |(3)逻辑判断结果颠倒吗? |否|   
|重要| 循环问题:  
  |(1)循环终止条件不正确吗? |否|  
  |(2)无法正常终止(死循环)吗? |否|  
  |(3)错误地修改循环变量吗?  |否| 
  |(4)存在误差累积吗? |否|  
|重要| 错误处理问题:  
  |(1)忘记进行错误处理吗?  |否| 
  |(2)错误处理程序块一直没有机会被运行?  |是| 
  |(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。|否|  
  |(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。  |否| 
|重要| 文件I/O问题:  
  |(1)对不存在的或者错误的文件进行操作吗?  |否| 
  |(2)文件以不正确的方式打开吗?  |否| 
  |(3)文件结束判断不正确吗?  |否| 
  |(4)没有正确地关闭文件吗?  |否|

3. 评价

  冯同学同学的这篇哈希表代码需要改进的地方还是有的。就代码实际内容讲,冗余代码较多,并且多数函数类型和返回值的定义没有用到,那么定义出这个类型就失去了意义。
整篇代码未涉及异常处理,稳定性较差,完全可以根据定义出的函数类型做出相应的异常处理。可能处于代码完成时间较早,当时对于写代码的思想还是依赖于自己的习惯,这里希望冯同学可以做小笔记了。
  前面也讲了代码完成时间较早,所以著作权版权声明没有是意料之中的,代码是有自己创造出来的一笔智慧财富,没有版权声明泼到网上就跟你一点关系也没有,冯同学可以增强一下个人权益意识,就想来是讲的万一以后被人拿去用,也是能够看得出这是你的一份功劳的。再者关键地方注释太过简洁,可能现在自己也看不太懂了(我看着是挺费劲)。
  由于是第一次复审,效率感觉很低,首先通读一遍代码想要理解代码逻辑真的很难,让我意识到注释的重要性。这次就是看一遍代码找一点缺点记下来,再看一遍......冯同学的代码里所存在的问题我的代码里肯定顶也有不少,知道自己问题所在肯定也是要改的,冯同学咱们一起进步吧(一起鸡蛋里面挑骨头)。

posted @ 2018-04-06 19:04  fashow  阅读(153)  评论(0)    收藏  举报