高级开发以及 leader 素质必备之代码评审(Code Review)

什么是代码评审?

1.代码评审是指在软件开发过程中,通过对源代码进行系统性检查的过程。通常的目的是查找系统缺陷,保证软件总体质量和提高开发者自身水平。
2.通常在企业开发中,会定期面对面(face to face)对代码进行评审

Code Review的意识
作为一个 Developer,不仅要提交可工作的代码(Deliver working code),更要提交可维护的代码(Deliver maintainable code)
必要时进行重构,随着项目的迭代,在计划新增功能的同时,开发要主动计划重构的工作项
开放的心态,虚心接受大家的评审建议(Review Comments)
代码评审的方式
开 Code Review 会议
团队内部会整理 Check List
团队内部成员交换代码
找出可优化方案
多问问题,例如:“这块儿是怎么工作的?”、“如果有XXX 情况,你这个怎么处理?”
区分重点,优先抓住设计,可读性,健壮性等重点问题
整理好的编码实践,用来作为 Code Review 的参考
评审内容
[1]架构/设计/常规
1.单一职责原则
这是经常被违背的原则。一个类只能干一个事情,一个方法最好也只干一件事情。比较常见的违背是一个类既干UI的事情,又干逻辑的事情,这个在低质量的客户端代码里很常见
2.行为是否统一,例如:
1.缓存是否统一
2.错误处理是否统一
3.错误提示是否统一
4.弹出框是否统一
……
3.代码污染
代码有没有对其他模块强耦合
4.重复代码-->应该抽取
5.开闭原则
6.面向接口编程
7.健壮性
是否考虑线程安全
数据访问是否一致性
边界处理是否完整
逻辑是否健壮
是否有内存泄漏
有没有循环依赖
有没有野指针
是否检查了数组的“越界“错误
……
8.错误处理
9.改动是不是对代码的提升
新的改动是打补丁,让代码质量继续恶化,还是对代码质量做了修复
10.效率/性能
1)关键算法的时间复杂度多少?有没有可能有潜在的性能瓶颈
2)客户端程序对频繁消息和较大数据等耗时操作是否处理得当
[2]代码风格
1.可读性
衡量可读性的可以有很好实践的标准,就是 Reviewer 能否非常容易的理解这个代码。如果不是,那意味着代码的可读性要进行改进
2.命名
命名对可读性非常重要
是否跟系统属性命名造成冲突
英语用词尽量准确一点,必要时可以查字典
3.函数长度/类长度
函数太长的不好阅读
类太长了,检查是否违反的 单一职责 原则
4.注释
恰到好处的注释,不是注释越多越好
5.参数个数
不要太多,一般不要超过 3 个
Review Your Own Code First
每次提交前整体把自己的代码过一遍非常有帮助,尤其是看看有没有犯低级错误

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355

推荐阅读更多精彩内容

  • 什么是代码评审? 1.代码评审是指在软件开发过程中,通过对源代码进行系统性检查的过程。通常的目的是查找系统缺陷,保...
    船长_阅读 8,255评论 3 57
  • 通常在企业开发中,会定期`面对面`(face to face)对代码进行评审 Code Review的意识 作为一...
    百事小武阅读 1,278评论 0 2
  • 通常在企业开发中,会定期面对面(face to face)对代码进行评审 1.Code Review的意识 作为一...
    IIronMan阅读 1,029评论 1 6
  • 转载自Jim's blog 关于Code Review的重要性,我相信好的工程师都能认识到。 参考 让Code R...
    Vinc阅读 1,540评论 0 14
  • 说到意义,我首先回想到的是布拉德里.特雷费.格里木的《生命的意义》,这本书是我初中无意中看到的,却对我产生了深刻而...
    梦觉Icy阅读 440评论 2 1