Alex Lin's Notes

Strategy, Execution, Communication.

代码复审的核查表

  1. 概要部分

    1. 代码符合需求和规格说明么?
    2. 代码设计是否考虑周全?
    3. 代码可读性如何?
    4. 代码容易维护么?
    5. 代码的每一行都执行并检查过了吗?
  2. 设计规范部分

    1. 设计是否遵从已知的设计模式或项目中常用的模式?
    2. 有没有硬编码或字符串/数字等存在?
    3. 代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)?
    4. 开发者新写的代码是否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?
    5. 有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)
  3. 代码规范部分

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

    1. 有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?
    2. 参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?
    3. 边界条件是如何处理的?switch 语句的 default 分支是如何处理的?循环有没有可能出现死循环?
    4. 有没有使用断言(Assert)来保证我们认为不变的条件真的得到满足?
    5. 对资源的利用,是在哪里申请,在哪里释放的?有无可能存在资源泄漏(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有优化的空间?
    6. 数据结构中有没有用不到的元素?
  5. 效能

    1. 代码的效能(Performance)如何?最坏的情况是怎样的?
    2. 代码中,特别是循环中是否有明显可优化的部分(C++ 中反复创建类,C# 中 string 的操作是否能用StringBuilder来优化)?
    3. 对于系统和网络的调用是否会超时?如何处理?
  6. 可读性
    代码可读性如何?有没有足够的注释?

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

针对特性领域的开发(如数据库、网页、多线程等),可以整理专门的核查表。

0%