codeReview规范

简介 review组方向merge权限人员xxx组xxxxxx售前xxxxx支付xxxxxx用户xxxxxx目前codeReview机制开发周期较长或是较重要的需求(由开发者自己把握),由开发者组织线下review,一般在公司约定会议室或是钉钉视频会议,参与评审的人提出修改意见,评审者针对修改意见进行修改开发周期较短且非关键的需求(由开发者自己把握),会由开发者发出线上review(MergeReque

review组

方向

merge权限

人员

xxx组xxxxxx
售前xxxxx
支付xxxxxx
用户xxxxxx

目前codeReview机制

  1. 开发周期较长或是较重要的需求(由开发者自己把握),由开发者组织线下review,一般在公司约定会议室或是钉钉视频会议,参与评审的人提出修改意见,评审者针对修改意见进行修改

  2. 开发周期较短且非关键的需求(由开发者自己把握),会由开发者发出线上review(Merge Request),参与评审的人提出修改意见,review完后complete此review请求

目前codeReview机制存在问题

  1. 没有review

  2. 参与Review的人太多了,意见太分散,Review时间拉的很长,发现问题效率低

  3. 有时候发现一个CodeReview时间很长,参与者可能会觉得煎熬和浪费时间

  4. 有时候不太了解对方评审的东西,没法跟上大家思路,影响效率

  5. 有时候走查的代码量太大了,无法做到详细走查,匆匆结束,根本发现不了问题,起不到reivew的作用

CodeReview的目标和原则

     CodeReview的目的是提升代码质量,尽早发现潜在缺陷与BUG,降低修复成本,同时促进团队内部知识共享,帮助更多人更好地理解系统。

     1. 发现代码的正确性代码

     2.不仅是在Review Code,更是在分享和学习


    • Code Review最重要的是讲解者分享业务流程和设计思路,使得更多人理解这个系统,提升团队整体水平,使得团队维护代码的能力提升。

     3. 高效迅速的完成CodeRevie


    • 我们不能为了应付匆匆忙忙的进行一次代码审查,效率也是很重要的,如果不能保证Code Review目的实现,那么评审便是徒劳的

 如何高效完成CodeReview?

      1. 检查设计的合理性和业务逻辑的正确性:


    • 代码设计是否考虑到后续业务的发展,而尽量避免定制化的设计。

    • 关注使用到的数据结构、设计模式和代码性能

    • 业务流程是否按照设计的流程走或者有丢失的流程

    • 某些传入参数是否合理

    • 是否有异常处理机制

    • 代码的设计是否符合设计要求

    • 业务逻辑是否正确

    • 关注业务可拓展性

      2.检查代码可读性和可维护性


    • 关注代码注释:函数和逻辑判断最好要标注一下这个函数或者这段判断是用来做什么的

    • 关注命名规范:可参考阿里JAVA开发规范

    • 关注重复代码:如果出现大量的重复性代码,要考虑将这些代码抽象出公用函数,以减少代码量并增强代码可读性。

    • 关注繁琐的逻辑:如果一个简单的功能却对应大篇幅的代码,要考虑一下是不是有比较简单的实现方式;如果没有简略的办法,一定要把注释写好。

      3. 分享设计、技术、知识和经验

 

如何快速完成CodeReview

         所谓的迅速就是节省时间,只要我们尽量避免一些意义不大的事情就能节省时间,加快评审速度


    • 如果评审内容比较多,评审者应该尽量拣核心的业务逻辑重点讲

    • 参与评审的人如果时间不允许全部review,也应该尽量拣自己感觉容易出问题的点去看,比如dubbo配置文件、当前需求会不会给其他功能带来影响等

    • 不要刻意地去寻找代码bug

    • 不要在不确定的问题上争来争去

 CodeReview的执行

     1. CodeReview前


    • 评审者应提前发出Review邀请,把需求文档和设计文档发给参与评审的人,这样参与评审的人可以提前了解业务需求和设计方案,避免评审时一头雾水,现场临时去了解业务需求,耽误大家的时间。

    • 线下reivew,评审者和参与者都要提前做好准备

    •  如果评审内容很多,且可以明显的划分出不同的业务模块或批次,建议分批次评审

     2. CodeReview中


    • 线下Review采取讲解与提问的方式

    • 线下Review过程中发现的问题,须准确的记录下来

    • 线上Review,直接在问题处提出评论

     3. CodeReview后


    • 确认问题点的修改时间及责任人

    • 确认问题点修改后的确认人


Top Top