代码复审核查表
我们组人员:28张洋,20王凯新,30何玉倩
任务分工 :张洋负责代码,王凯新负责窗体,何玉倩负责审查。
1.概要部分
(1)代码能符合需求和规格说明么?
说明代码基本上没有出现多少错误,但是不代表代码就是完全正确无误的,其中还有其他条件的限制,包括执行后是否能够达到目的。
(2)代码设计是否有周全的考虑?
代码的设计是比较周全的,但不是绝对的,我们的能力也许有限,并不能考虑到所有的方面,若有一定的疏漏还需关注。
(3)代码可读性如何?
代码具有一定的可读性。
(4)代码容易维护么?
由于在程序中存在未知漏洞,由于使用产生的积累问题,为了补充新功能而对程序的代码进行修改维护。我们还未做到这点,我们没发现程序中的未知漏洞。
(5)代码的每一行都执行并检查过了吗?
对于可读的代码,我们进行了一步步的检查;除此之外,我们通过执行程序,来检查代码中是否还存在问题。事实证明,程序是没有问题的,但是一些潜在的问题,未被发现的问题,我们可能并没有发现,所以这类问题,没有进行检查。
2.设计规范部分
(1)设计是否遵从已知的设计模式或项目中常用的模式?
设计遵从已知的设计模式或项目中常用的模式。
(2)有没有硬编码或字符串/数字等存在?
有硬编码或字符串/数字等存在。
(3)代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)?
随着软件对计算机主存的需求的扩张,32位平台的4G主存寻址空间逐渐成为机器性能的瓶颈,长期来看,解决这一矛盾的最优方案是使用支持更大主存空间的软件运行平台。就当前来所,PC机上支持更大地址空间的硬件平台就是x64了,当然除了硬件外还需要64位的操作系统和运行时库的支持,才能运行64位的应用程序。看来这种改变是比较复杂的,代码依赖某一平台,影响到将来的移植,但是这个问题是可以解决的。
(4)开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?
新写的代码没有用已有的Library/SDK/Framework中的功能实现,在本项目中并不存在类似的功能可以调用而不用全部重新实现。
(5)有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)
有,许多代码都不必添加,程序简单,利落,直接命中才是我们想要的程序,而多余的那些功能代码,可以直接应用到以后的练习中。
3.代码规范部分
(1)修改的部分符合代码标准和风格么(详细条文略)?
代码风格规范:简明,易读,无二义性。在一定基础上,修改的部分符合。
4.具体代码部分
(1)有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?
我们对错误进行了处理,检查了返回值和异常处理。
(2)参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?
参数没有错误,字符串的长度是字符长度,是以0开始计数。
(3)边界条件是如何处理的?Switch语句的Default是如何处理的?循环有没有可能出现死循环?
没有边界条件。没有Switch语句的Default,循环没有出现死循环。
(4)有没有使用断言(Assert)来保证我们认为不变的条件真的满足?
没有使用断言(Assert)来保证我们认为不变的条件真的满足。
(5)对资源的利用,是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有可能优化?
这个真的可以没有……
(6)数据结构中是否有无用的元素?
数据结构中没有无用的元素。
5.效能
(1)代码的效能(Performance)如何?最坏的情况是怎样的?
代码可以直接完成功能,所以说效能还是不错的,但是速度的快,之类的,我们真达不到这种水平,这样的程序,也应该不必要效能测试,最坏的情况无不是代码无法完成需求,出现错误,速度慢。
(2)代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中 string 的操作是否能用StringBuilder 来优化)?
代码中的循环并不多,所以没必要再进行所谓的优化。也没有明显的优化部分。
(3)对于系统和网络调用是否会超时?如何处理?
没有网络的调用,这个应该也不用考虑把……
6.可读性
代码可读性如何?有没有足够的注释?
代码具有一定的可读性,有足够的注释。
7.可测试性
代码是否需要更新或创建新的单元测试?
不需要,单元测试对于这样的一个程序来说真的多此一举。