进行代码复审训练

一、结对,找到一个伙伴进行结对;(在作业中标注自己的伙伴博客链接)

伙伴博客链接 http://www.cnblogs.com/A1Meng/p/8592441.html

二、各自对自己的伙伴上周进行的“单元测试”练习所完成的代码进行复审,形成“代码复审检查表”。

代码复审核查表 

概要部分

代码符合需求和规格说明么?

能够符合需求和规格说明

代码设计是否考虑周全?

不是很周全

代码可读性如何?

可读性一般

代码容易维护么?

维护性一般

代码的每一行都执行并检查过了吗?

都执行并检查过了

设计规范部分

设计是否遵从已知的设计模式或项目中常用的模式?

有没有硬编码或字符串/数字等存在?

有存在部分

代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)?

没有

开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?

不能,存在

有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)

没有

代码规范部分

修改的部分符合代码标准和风格么(详细条文略)?

符合

具体代码部分

有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?

有,已检查

参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?

没有,字节,以0开始

边界条件是如何处理的?Switch语句的Default是如何处理的?循环有没有可能出现死循环?

判断处理,没有switch语句,没有可能出现死循环

有没有使用断言(Assert)来保证我们认为不变的条件真的满足?

没有

对资源的利用,是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有可能优化?

在数组中申请和释放,可能,可能

数据结构中是否有无用的元素?

没有

效能

代码的效能(Performance)如何?最坏的情况是怎样的?

性能一般,执行时间久

代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中string的操作是否能用StringBuilder来优化)?

没有

对于系统和网络调用是否会超时?如何处理?

不会超时

可读性

代码可读性如何?有没有足够的注释?

可读性一般,没有

可测试性

代码是否需要更新或创建新的单元测试?针对特定领域开发(如数据库、网页、多线程等)的核查表。

不需要

代码复审感想

首先应该明白代码复审的正确定义是:看代码是否在代码规范的框架内正确地解决了问题。其次我们在这个过程中遇到的第一个问题就是:在看别人的代码没有注释。没有注释给我们阅读带来了很多的麻烦。定义了一堆的变量,完全不知道是做什么用的。对于这样一个小的工程来讲,仔细看一看,还是可以看明白的。但是对于更大的工程呢?这时,突然想起来,我自己写的代码注释也基本为零,可以想象阅读我的代码同学也非常的痛苦。最后,通过这个过程,还是学到了很多,明白了别人的代码就像一面镜子,在给别人指出错误缺陷的时候,我们也能感受到自己的程序存在的问题。

原文地址:https://www.cnblogs.com/Aibb/p/8617328.html