代码审查规范标准[详].pdfVIP

.. .. .. .. 代码审查规范 1. Code Review 目的 Code Review 是一种用来确认方案设计和代码实现的质量保证机制，通过这个机制我 们可以对 代码、测试过程 和 注释 进行检查。 Code Review 主要用来在软件工程过程中改进代码质量，通过 Code Review 可以达 到如下目的： 在项目早期就能够发现代码中的 BUG 。 帮助初级开发人员学习高级开发人员的经验，达到知识共享。 避免开发人员犯一些很常见，很普通的错误。 保证项目组人员的良好沟通。 项目或产品的代码更容易维护。 2. Code Review 的前提条件 代码提交审核前， 开发者 必须确保代码符合如下条件， 审核者 需要确保所有前提条件 都已满足方可开始审查，同时也是审查的主要检查点。 所有代码注释清晰，语法正确，编译通过。 日志代码完整，业务日志、系统日志分开，中文描述，脱敏处理，状态变更， 全部清晰明确。 测试代码覆盖全部分支和流程，暂时统一使用工具 Emma （各编译器可下载对 应插件）进行 Coverage Check 。 项目引用关系明确，依赖关系清晰，配置文件描述。 3. Code Review 的审查范围 代码的一致性、编码风格、代码的安全问题、脱敏问题、代码冗余、是否正确设计以符 合设计要求（性能、功能）与设计文档相同等等。 3.1 、 完整性检查（ Completeness ） 代码是否完全实现了设计文档中所涉及的所有流程和功能点 代码是否已包含所有所需的业务日志、系统日志、异常日志，日志内容是否完 整，日志文件配置是否正确。 参考 .资料 .. .. .. .. 代码是否使用缓存等，配置信息是否正确可配置。 代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型等 3.2 、 一致性检查（ Consistency ） 代码的逻辑是否符合设计文档 代码中使用的格式、符号、结构等风格是否保持一致 3.3 、 正确性检查（ Correctness ） 代码是否符合制定的标准 所有的变量都被正确定义和使用 所有的注释都是准确的 所有的程序调用都使用了正确的参数个数 3.4 、 可修改性检查（ Modifiability ） 代码涉及到的常量是否易于修改 ( 如使用配置、定义为类常量、使用专门的常量 类等 ) 代码中是否包含了交叉说明或数据字典，以描述程序是如何对变量和常量进行 访问的 代码是否只有一个出口和一个入口（严重的异常处理除外） 3.5 、 可预测性检查（ Predictability ） 代码所用的开发语言是否具有定义良好的语法和语义 是否代码避免了依赖于开发语言缺省提供的功能 代码是否无意中陷入了死循环 代码是否避免了无穷递归 3.6 、 健壮性检查（ Robustness ） 代码是否采取措施避免运行时错误（如数组边界溢出、被零除、值越界、堆栈 溢出等） 3.7 、 结构性检查（ Structuredness ） 程序的每个功能是否都作为一个可辩识的代码块存在 参考 .资料 .. .. .. .. 循环是否只有一个入口 3.8 、 可追溯性检查（ Traceability