【软件工程基础】代码复审

代码复审

1.概要部分

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

代码设计是否有周全的考虑?

分了好几个类,看起来设计上是有些考虑的,但是某些函数过大。

代码可读性如何?

代码没有注释,函数和变量命名都有意义,但是存在多层循环,不太看得懂意思。

代码容易维护么?

Calculator类中的存在特别长的函数,如果需要修改可能会比较麻烦。其他部分通过类封装的比较好,会容易维护一些。

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

都执行过

2.设计规范部分

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

没有用到设计模式

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

几乎所有的循环都有固定的常数控制。

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

代码使用C#编写,基于.net Framework,跨平台没有问题。

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

代码中多处使用了.net Framework的库。

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

没有。

3.代码规范部分

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

基本符合。

4.具体代码部分

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

两个Handler类中都对错误进行了处理。

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

没有错误。字节长度。

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

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

没有

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

C#自动回收资源。

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

没有。

5.效能

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

效率上需要优化,在性能测试中,并没有完成生成较大量数独的任务。

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

使用了StringBuilder来优化输出。

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

6.可读性

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

没有注释。因此导致某些复杂的函数不太能读懂。

7.可测试性

代码是否需要更新或创建新的单元测试?

单元测试写了很多,并不需要。

还可以有针对特定领域开发(如数据库、网页、多线程等)的核查表。

设计代码规范

工具提供的代码规范和你个人的代码风格有什么不同?

  • 局部变量最好声明和初始化在一起
  • 使用智能指针

工具提供的代码规范里有哪些部分是你之前没有想到的?

上面的不同都没有想到

为什么要这样规范?这样的规范有意义吗?

这样的规范提高了代码的可读性、可维护性,一定程度上能减少bug,并且使得debug变得容易。提高程序的鲁棒性。

posted on 2017-10-03 22:32  Damocles  阅读(315)  评论(0编辑  收藏  举报

导航