红帽白皮书新鲜出炉!点击获取,让你的云战略更胜一筹! 了解详情
写点什么

如何做好 Code Review?

  • 2019-09-23
  • 本文字数:1481 字

    阅读完需:约 5 分钟

如何做好Code Review?

1. 背景

最近随着交易业务快速扩展,研发组内新项目及新成员越来越多,如何做好 Code Review,把控研发人员开发代码质量很是关键。


对于大部分业务团队,谈到 Code Review 就会面露哀状:


“上线时间倒排,研发工期这么紧,连码代码的时间都不够了,你还要我 CR?”


“上版的需求,这版就变了,代码生命周期太短,烂就烂吧,反正能用就行啦”

2. 抛出问题

下面分几个方面来分析下 Code Review:


  • Code Review 有没有用?

  • Code Review 中的问题如何解决?

  • 如何做好 Code Review?

3. 分析问题

1)Code Review 有没有用?


Code Review 的好处不言而喻。主要让你的代码可以更好的组织搭建,有更高可读性,且更容易维护,同时可以知识共享,相对而言,找 Bug 并不是那么的重要。


总结一句话,Code Review 可以直接影响你的工程能力。


2)Code Review 中的问题如何解决?


Code Review 中的主要问题:


编码质量较差


原因可能是对业务不熟悉,对语言应用技巧不熟悉,也可能对公司、部门编码规范不熟悉等等,有些问题如果没人及时提醒纠正的话,只会造成在错误的道路上越走越远。


自己承担还是指导他人?


Code Review 是一个学习过程,将自己的一些经验指导给新人,从长远来看,是在“复制”你的生产力,一个人能力再强,也不可能包揽所有的任务,团队协作也是研发人员需要注重培养的软素质。


主要 Review 什么?


编码风格,大家约定俗成的规范准则,从新人开始一步步坚持下去;


代码可读性,代码写出来是叫别人可以读懂的,而且是易读的;


全面性,业务实现异常情况考虑不全面的问题,需要老工程师指导,以免造成线上故障;


不良代码或架构,错误的代码实现、功能函数抽象以及文件组织等,都需要尽量保持整个代码库的风格一致。


3)如何做好 Code Review?


Code Review 机制一定是要与团队规模和项目节奏挂钩的。


Code Review 频次如何控制?


研发前期需要技术方案设计评审,日常 Code Review 保证开发过程中代码质量,研发完成后项目 Code Review 是为了呼应前期评审过的技术方案,确认哪些方案变更了,是由于什么原因等等。


如:大型项目,每天 Code Review 一次;小优化需求,merge request 时候 Code Review 一次即可。


Tips:Code Review 一定要尽可能前置,防止测试后改动问题造成影响。


Code Review 时间如何控制?


一次不要检查过多代码,控制在 1 小时以内,一个研究机构调查指出,太多信息或者 60 分钟以后,发现缺陷的能力就会降低。


作者在审核前需要注释源代码


在他人评审之前,自己 Review 一遍实现思路,说不定会有意外收获呢。


使用 Checklist


可能团队内人员会犯同样的错误,一遍遍重复查找费时费力,应该整理核对 Checklist 来缩减经常出现的错误的排查时间,同样 Checklist 也有利于问题统计和跟踪改进结论。


改进问题要及时


争取当天问题当天解决,同时 Code Review 新问题之前,先回顾一下之前遗留问题是否修复,做到 Code Review 行之有效。


培养积极的 Code Review 文化


Code Review 是团队提高代码质量的机会,也是互相学习的过程;建立接受他人评审的潜意识,我的工作产出是需要其他人 Review 的,这种自我激励会自然的要求自己产出更优秀的代码。

4. 写在最后

作为研发工程师,首先要对自己负责的业务和代码负责,这个与医生、教师的岗位职责是一样的。如果开发没有标准,对应该高标准的东西一味妥协,自己的标准一降再降,到最后吃亏的还是自己。


作者介绍:


张欢,平台交易事业部,2017 年 9 月加入贝壳找房,任职 PHP 资深研发工程师,目前负责交易 C 端 &内容库 &指标平台方向研发工作。


本文转载自公众号贝壳产品技术(ID:gh_9afeb423f390)。


原文链接:


https://mp.weixin.qq.com/s/Taze_uNtgZ7jI_qLnxgLDA


2019-09-23 08:001925

评论 1 条评论

发布
用户头像
作者可以聊聊怎么做好cr
2021-11-04 01:30
回复
没有更多了
发现更多内容

如何看待国企纷纷卸载微软Office改用金山WPS?

优秀

wps office办公软件

C#/VB.NET 合并PDF文档

在下毛毛雨

C# .net PDF 文件合并

6月刊 | AntDB数据库参与编写《数据库发展研究报告》 亮相信创产业榜单

亚信AntDB数据库

数据库 AntDB 国产数据库

向Spring框架学习设计模式

慕枫技术笔记

设计模式 spring框架 7月月更

MySQL审计插件介绍

Simon

MySQL 运维 MySQL 数据库

数据湖系列之一 | 你一定爱读的极简数据平台史,从数据仓库、数据湖到湖仓一体

Baidu AICLOUD

大数据 数据仓库 数据湖 对象存储 湖仓一体

嗨 FUN 一夏,与 StarRocks 一起玩转 SQL Planner!

StarRocks

sql 大数据 数据库·

刘对(火线安全)-多云环境的风险发现

火线安全

云安全 云安全技术 云安全研究

直播带货系统软件开发,Android和iOS的区别在哪里?

开源直播系统源码

ios开发 Android开发 直播带货系统 原生开发 混合开发

华为发布HCSP-Solution-5G Security人才认证,助力5G安全人才生态建设

Geek_2d6073

StoneDB 为国产数据库添砖加瓦,基于 MySQL 的一体化实时 HTAP 数据库正式开源!

StoneDB

大数据 MySQL 数据库 #数据库 HTAP #开源

独家消息:阿里云悄然推出RPA云电脑,已与多家RPA厂商开放合作

王吉伟频道

阿里云 RPA 无影云电脑 RPA云电脑 RPA+DaaS

重磅披露!上百个重要信息系统被入侵,主机成为重点攻击目标

青藤云安全

网络安全 网络攻击防御

洞态在某互联⽹⾦融科技企业的最佳落地实践

火线安全

漏洞检测 IAST

60 个前端 Web 开发流行语你都知道哪些?

海拥(haiyong.site)

前端 Web 7月月更

Python|小白如何入门Python?记我的Python初体验

AXYZdong

7月月更

ABAP-屏幕切换时,刷新上一个屏幕

桥下本有油菜花

abap

远程办公经验?来一场自问自答形式的介绍吧~ | 社区征文

为自己带盐

初夏征文 7月月更

单集群1万节点!腾讯云大数据平台TBDS获得分布式批处理平台万节点能力认证

科技热闻

[Ljava.lang.Object;是什么?

okokabcd

Java

她就是那个「别人家的HR」|ONES 人物

万事ONES

如何写出好代码 - 防御式编程指南

云智慧AIOps社区

Java 架构 代码质量

【计算讲谈社】第四讲:自动驾驶,未来的移动智能载体?

大咖说

自动驾驶 阿里云 科技

K8S 应用部署

kubenetes

越来越多地使用 SLO 来实现可观测性|DevOps

观测云

可观测性

SAP 智能机器人流程自动化(iRPA)解决方案分享

Jerry Wang

SAP 业务流程自动化 7月月更 企业自动化 iRPA

leetcode 322. Coin Change 零钱兑换(中等)

okokabcd

LeetCode 动态规划 算法与数据结构

户外LED显示屏应该考虑哪些问题?

Dylan

LED显示屏 户外LED显示屏

贝联珠贯加入龙蜥社区,共同促进碳中和

OpenAnolis小助手

开源 龙蜥社区 CLA 贝联珠贯 IT资源利用

ABAP-调用Restful API

桥下本有油菜花

abap REST API

博睿数据一体化智能可观测平台入选中国信通院2022年“云原生产品名录”

博睿数据

智能运维 博睿数据 One 智能可观测平台

如何做好Code Review?_文化 & 方法_张欢_InfoQ精选文章