代码评审(Code Review)

 通常在企业开发中,会定期`面对面`(face to face)对代码进行评审

 Code Review的意识

作为一个 `Developer`,不仅要`提交可工作的代码`(Deliver working code),更要`提交可维护的代码`(Deliver maintainable code)

 必要时进行重构,随着项目的迭代,在计划新增功能的同时,开发要主动计划重构的工作项

 开放的心态,虚心接受大家的`评审建议`(Review Comments)

 代码评审的方式

 开 Code Review 会议

 团队内部会整理 Check List

 团队内部成员交换代码

 找出可优化方案

 多问问题,例如:“这块儿是怎么工作的?”、“如果有XXX 情况,你这个怎么处理?”

 区分重点,优先抓住`设计`,`可读性`,`健壮性`等重点问题

 整理好的编码实践,用来作为 `Code Review` 的参考

 评审内容

 架构/设计

 单一职责原则

 这是经常被违背的原则。一个类只能干一个事情,一个方法最好也只干一件事情。比较常见的违背是`一个类既干UI的事情,又干逻辑的事情`,这个在低质量的客户端代码里很常见

  行为是否统一,例如:

 缓存是否统一

  错误处理是否统一

 错误提示是否统一

 弹出框是否统一

  ……

  代码污染

  代码有没有对其他模块强耦合

 重复代码

 开闭原则

  面向接口编程

 健壮性

 是否考虑线程安全

 数据访问是否一致性

 边界处理是否完整

  逻辑是否健壮

 是否有内存泄漏

 有没有循环依赖

  有没有野指针

  ……

 错误处理

 改动是不是对代码的提升

新的改动是打补丁,让代码质量继续恶化,还是对代码质量做了修复

效率/性能

关键算法的时间复杂度多少?有没有可能有潜在的性能瓶颈

客户端程序对频繁消息和较大数据等耗时操作是否处理得当

代码风格

 可读性

衡量可读性的可以有很好实践的标准,就是 Reviewer 能否非常容易的理解这个代码。如果不是,那意味着代码的可读性要进行改进

命名

命名对可读性非常重要

英语用词尽量准确一点,必要时可以查字典

函数长度/类长度

函数太长的不好阅读

类太长了,检查是否违反的 `单一职责` 原则

注释

 恰到好处的注释

参数个数

不要太多,一般不要超过 3 个

 Review Your Own Code First

每次提交前整体把自己的代码过一遍非常有帮助,尤其是看看有没有犯低级错误

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

推荐阅读更多精彩内容