一、题目要求

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

二、结对成员与coding地址
（1）在这次结对作业中，我选择了伙伴——耿蝶芮，主要对其校运动会成绩统计的项目代码进行审查，并绘制代码审查表。
（2）其校运动会成绩统计项目的代码已上传到coding.net系统中，地址为：https://dev.tencent.com/u/iyuye/p/xiaoyundonghuichengjitongji/git/blob/master/%E6%A0%A1%E8%BF%90%E5%8A%A8%E4%BC%9A%E6%88%90%E7%BB%A9%E7%BB%9F%E8%AE%A1.cpp
三、绘制代码审查表

SRE实战 互联网时代守护先锋，助力企业售后服务体系运筹帷幄！一键直达领取阿里云限量特价优惠。
功能模块名称 校运动会成绩统计系统
审查人  王成成  审查日期 2019.4.25
代码名称  校运动会成绩统计  代码作者  耿蝶芮 
文件结构
重要性 审查项目 结论
头文件和定义文件的名称是否合理？  是 
头文件和定义文件的目录结构是否合理？  是 
版权和版本声明是否完整？  否 
重要 头文件是否使用了 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语句时是否留下隐患？
例如跳过了某些对象的构造、变量的初始化？		  未涉及 
常量
重要性 审查项目 结论
是否使用含义直观的常量来表示那些将在程序中
多次出现的数字或字符串？		  是 
是否误解了类中的const数据成员？
因为const数据成员只在某个对象		  未涉及 
重要 如果某一常量与其它常量密切相关，
是否在定义中包含了这种关系？		  是 
生存期内是常量，而对于整个类而言却是可变的。  未涉及 
函数设计
重要性 审查项目 结论
参数的书写是否完整？
不要贪图省事只写参数的类型而省略参数名字。		  是 
参数命名、顺序是否合理？  是 
参数的个数是否太多？  否 
是否使用类型和数目不确定的参数？  否 
是否省略了函数返回值的类型？  否 
函数名字与返回值类型在语义上是否冲突？  未涉及返回值 
重要 是否将正常值和错误标志混在一起返回？
正常值应当用输出参数获得，而错		  否 
重要 在函数体的“入口处”，
是否用assert对参数的有效性进行检查？		  否 
重要 使用滥用了assert？ 例如混淆非法情况与错误情况，
后者是必然存在的并且		  未涉及 
重要 return语句是否返回指向“栈内存”的“指针”或者“引用”？  未涉及return语句 
是否使用const提高函数的健壮性？
const可以强制保护函数的参数、返回值。		  否 
内存管理
重要性 审查项目 结论
重要 用malloc或new申请内存之后，
是否立即检查指针值是否为NULL？		  否 
重要 是否忘记为数组和动态内存赋初值？  否 
重要 数组或指针的下标是否越界？  否 
重要 动态内存的申请与释放是否配对？  否 
重要 是否有效地处理了“内存耗尽”问题？  否 
重要 是否修改“指向常量的指针”的内容？  是 
重要 是否出现野指针？例如
1) 指针变量没有被初始化。  否 
2) 用free或delete释放了内存之后，忘记将指针设置为NULL。  未释放内存 
重要 是否将malloc/free 和 new/delete 混淆使用？  否 
重要 malloc语句是否正确无误？例如字节数是否正确？
类型转换是否正确？		  是 
重要 在创建与释放动态对象数组时，new/delete的语句是否正确无误？  是 
其它常见问题
重要性 审查项目 结论
重要 数据类型问题：
1) 变量的数据类型有错误吗？  否 
2) 存在不同数据类型的赋值吗？  否 
3) 存在不同数据类型的比较吗？  否 
重要 变量值问题：
1) 变量的初始化或缺省值有错误吗？  否 
2) 变量发生上溢或下溢吗？  否 
3) 变量的精度够吗？  够 
重要 逻辑判断问题：
1) 由于精度原因导致比较无效吗？  否 
2) 表达式中的优先级有误吗？  否 
3) 逻辑判断结果颠倒吗？   否 
重要 循环问题：
1) 循环终止条件不正确吗？  否 
2) 无法正常终止（死循环）吗？  否 
3) 错误地修改循环变量吗？  否 
4) 存在误差累积吗？  否 
重要 错误处理问题：
1) 忘记进行错误处理吗？  否 
2) 错误处理程序块一直没有机会被运行？  否 
3) 错误处理程序块本身就有毛病吗？  否 
4) 错误处理程序块是“马后炮”吗？
如在被它被调用之前软件已经出错。		  否 
重要 文件I/O问题：
1) 对不存在的或者错误的文件进行操作吗？  未涉及 
2) 文件以不正确的方式打开吗？  未涉及 
3) 文件结束判断不正确吗？  未涉及 
4) 没有正确地关闭文件吗？  未涉及 

四、代码质量分析
  在对耿蝶芮同学的代码进行分析审查的时候，我发现了一些问题。在这部分里，我仅代表个人对于代码的看法，做出一些评价。
1、代码之优点

（1）代码整体运行起来没有任何错误，提供了一定的可靠性。
（2）代码具有对输入信息的错误处理功能
（3）代码整体结构较完善，能够充分满足任务要求。

2、代码之不足

（1）代码中对于变量的定义都放在了一行。在该程序中，定义新变量较少，但如果变量较多，看起来过于冗杂。
（2）代码中if判断语句与满足判定条件后的执行语句放在同一行上，虽然不影响功能和执行，但看起来不是特别规整。
（3）该代码运用指针，使用了malloc语句创建空间，但却忽略了free语句。只创建空间，而在用完后不予释放，在一定程度上浪费了内存空间。

五、总结
  本次结对作业让我学会了如何审查他人的代码，并找到其优点和不足。通过对耿蝶芮同学的代码进行审查，我发现耿蝶芮同学对于代码规范处理的很好，并且能够熟练运用指针数组等相关内容。除此之外，她的编码风格以及对于注释的处理，尤其是结构体中变量的定义处理的非常形象，非常值得我学习。通过代码复审，可以让自己看到他人在编程时的一些习惯、优点和不足，这对于自己今后的代码编写起到了一定的助推作用。当自己看别人代码的时候，自己就会想到这个地方我处理的怎么样啊，对方的哪些优点在我编程的时候可以用到等等。自己希望在将来编写代码的时候能够充分借用他人视角来看待自己的代码，并且能够进行合理分析，从而逐步完善代码，形成良好的代码规范。

扫码关注我们
微信号：SRE实战
拒绝背锅 运筹帷幄