代码评审
上一篇 /
下一篇 2012-12-20 22:40:49
/ 个人分类：质量管理
写在前面送给每个程序员的话：任何人都能写出机器看得懂的代码，写出人能看懂的代码是种专业和美德！
构建高质量的软件时，评审源代码是对编译、集成和测试等其他质量保证机制的补充。在代码评审之前，要对其进行编译，并使用诸如代码规则检查器之类的工具来发现尽可能多的错误。如果使用可在运行时检测错误的工具来执行代码，还能够在进行代码评审之前检测和消除其他错误。
代码评审的优点有：
- 加强和鼓励在项目中使用一种共同的编码风格。代码评审是一种有效的让成员遵循编程指南的方法。要确保成员遵循编程指南，评审所有作者和实施者的工作结果要比评审所有源代码文件重要得多。
- 发现自动测试发现不了的错误。代码评审捕捉到的错误与测试发现的错误不同。
- 交流个人知识，并让富有经验的个人将知识传授给经验较少的新手。
源代码检查点
如下是一些通用的代码评审检查点，仅作为代码评审的示例。编程规范应作为代码质量的主要信息源。
概述
- 代码是否遵循编程规范？
- 代码是否有自我记录功能？能否通过阅读理解代码？
- 是否已经解决了代码规则检查和（或）运行错误检测工具发现的所有错误？
注释
- 注释是否反映了最新的情况？
- 注释是否清晰正确？
- 如果代码被变更，修改注释是否容易？
- 注释是否着重解释了为什么，而不是怎么样？
- 是否所有的意外、异常情况和解决方法错误都有注释？
- 每个操作的目的是否都有注释？
- 与每个操作有关的其他事实是否都有注释？
源代码
- 是否每一个操作都有一个描述其操作内容的名称？
- 参数是否有描述性的名称？
- 完成各个操作的正常路径是否与其他异常路径有明显区别？
- 操作是否太长，它能否通过将有关语句提取到专用操作中进行简化？
- 操作是否太长，它能否通过减少判定点的数目进行简化？决策点是代码可以采取不同路径的语句，例如 if-、else-、and-、while- 和 case- 语句。
- 循环嵌套是否已减至最少？
- 变量命名是否适当？
- 代码是否简单明了，是否避免了使用“技巧性”的方法？
收藏
举报
TAG:
