代码审查规范

灰太狼 2024-03-22 10:33 286阅读 0赞

1. Code Review目的

Code Review是一种用来确认方案设计和代码实现的质量保证机制，通过这个机制我们可以对 代码、测试过程 和 注释 进行检查。
Code Review主要用来在软件工程过程中改进代码质量，通过Code Review可以达到如下目的：

  • 在项目早期就能够发现代码中的BUG。
  • 帮助初级开发人员学习高级开发人员的经验，达到知识共享。
  • 避免开发人员犯一些很常见，很普通的错误。
  • 保证项目组人员的良好沟通。
  • 项目或产品的代码更容易维护。

2. Code Review的前提条件

代码提交审核前，开发者 必须确保代码符合如下条件，审核者 需要确保所有前提条件都已满足方可开始审查，同时也是审查的主要检查点。

  • 所有代码注释清晰，语法正确，编译通过。
  • 日志代码完整，业务日志、系统日志分开，中文描述，脱敏处理，状态变更，全部清晰明确。
  • 测试代码覆盖全部分支和流程，暂时统一使用工具Emma（各编译器可下载对应插件）进行Coverage Check。
  • 项目引用关系明确，依赖关系清晰，配置文件描述。

3. Code Review的审查范围

  • 代码的一致性、编码风格、代码的安全问题、脱敏问题、代码冗余、是否正确设计以符合设计要求（性能、功能）与设计文档相同等等。

完整性检查（Completen

发表评论

表情：
评论列表 （有 0 条评论，286人围观）

还没有评论，来说两句吧...

相关阅读

    相关 代码审查规范

    1. Code Review目的 Code Review是一种用来确认方案设计和代码实现的质量保证机制，通过这个机制我们可以对 代码、测试过程 和 注释 进行检查。

    灰太狼灰太狼/ 0 赞/ 287 阅读