代码审查规范方案

代码审查规范 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） • 代...