代码审核规范版本1.0
需积分: 23 100 浏览量
2019-02-21
14:58:02
上传
评论
收藏 63KB DOCX 举报
代码审查规范
1. Code Review 目的
Code Review 是一种用来确认方案设计和代码实现的质量保证机制，通过这个机制我们
可以对 代码、测试过程 和 注释 进行检查。
Code Review 主要用来在软件工程过程中改进代码质量，通过 Code Review 可以达到如
下目的：
在项目早期就能够发现代码中的 BUG。
帮助初级开发人员学习高级开发人员的经验，达到知识共享。
避免开发人员犯一些很常见，很普通的错误。
保证项目组人员的良好沟通。
项目或产品的代码更容易维护。
2. Code Review 的前提条件
代码提交审核前，开发者 必须确保代码符合如下条件，审核者 需要确保所有前提条件
都已满足方可开始审查，同时也是审查的主要检查点。
所有代码注释清晰，语法正确，编译通过。
日志代码完整，业务日志、系统日志分开，中文描述，脱敏处理，状态变更，全
部清晰明确。
测试代码覆盖全部分支和流程，暂时统一使用工具 Emma（各编译器可下载对应
插件）进行 Coverage Check。
项目引用关系明确，依赖关系清晰，配置文件描述。
3. Code Review 的审查范围
代码的一致性、编码风格、代码的安全问题、脱敏问题、代码冗余、是否正确设计以
符合设计要求（性能、功能）与设计文档相同等等。
3.1 、 完整性检查（Completeness）
代码是否完全实现了设计文档中所涉及的所有流程和功能点
资源评论
