为什么要关注代码的可读性?

《技术人员如何拥抱变化》一文中阐述了技术人员从多个角度在技术上达到拥抱变化的能力。在《从Simple Design入手代码易修改》中着重讲述了Simple Design中如何做好,让代码具有应对变化的能力。我们现在聚焦代码可读性对应对变化的影响。

在Code Review时,经常有小伙伴提出以下类似问题:

“这段代码方法名起的不好”
“这个变量不明白实际意图”
“某个接口没有按照规范命名”
...

这些都是代码可读性不强时的一些表现。被Challenge的同学要么接受反馈并探索好的实践方式,要么开始为自己辩解开拓。一次Code Review可能很多被可读性问题的讨论把时间占据了。

那要不要关注代码的可读性呢?

实事求是一点的话还要区分场景。

如果是一次性代码,一次写完,这辈子都会回在看的,那怎么写都可以。

如果是团队性代码或者后续经常翻看修改,那么就需要关注可读性。

为什么团队性项目更需要关注代码的可读性?

团队性项目往往是在开发复杂的软件。复杂的软件具有以下特点:

1. 需求不确定;
2. 需求推出者对需要的产品有一个认识的过程。
3. 产品本身也是一个进化的过程。

需求不确定、认识、进化的过程都会发生变化。

而十几年前在敏捷的十二条原则中的第二条就已经描述了如何面对这些变化:

"欣然面对需求变化,即使在开发后期也一样,为了客户的竞争优势,敏捷过程掌控变化。"

为了获得竞争优势,需要沟通,控制各种成本。在一番权衡之后,最终决定坚持变化。

变化就真的发生了,作为开发人员如何应对这些变化?

团队中的所有人员都期望能够达到以下的状态:

有了变化,开发人员能够保证质量的同时快速完成。
有了Bug,开发人员能够保证质量的同时快速修复。

但是解决办法绝对不是仅仅意识到要沟通、要协作、加班这么简单。而是要提升开发人员的自身能力。

为了能够实现快速完成和保证质量,首先是善用工具,其次是修改代码。

如果工具或者某种设计思路能够快速完成,最终还是要回到人为修改代码上来。

读代码和写代码的过程时间分配是10:1。人要先读代码,再修改代码。读代码的速度影响了修改的速度。下面是一次实际修改过程。

一次实际修改过程

我们不难想象修改易读代码和可读性差的代码是的状态。下图形象的表达了衡量代码质量的唯一有效标准:WTF/min。

衡量代码质量的唯一有效标准:WTF/min

绕了一大圈,其实就是: 可读性强的代码,在我们做复杂软件开发时更有利于开发人员拥抱变化,抓住商机,实现价值。

既然修改、添加代码是可读性对我们很有帮助,那么绝对不是修改时才去关注代码结构、类名、方法名、变量名。而是在代码开发的时候就维持好可读性,并作为一种团队开发的常态。

最后,我们再来回顾下Code Review是关于可读性问题的讨论,其实是值得,只有有了这样的过程,团队代码风格才能逐渐统一,修改起来也就更加顺畅。可读性问题被真正解决了,后续Code Review在可读性问题上讨论的时间才会减少。最终,团队才能离真正离拥抱变化更进一步。

最后,怎么让代码具有良好的可读性?

留下一些线索:

技术部分:

IDE特性: [短时间让你扔掉鼠标的Intellij IDEA的插件](https://www.jianshu.com/p/14e9fed878fd)
语言特性
代码结构
Simple Design
设计原则
设计模式

非技术部分:

接受反馈
走出舒适区
刻意练习

有句古老的谚语,能够帮助我们聚焦提升自身技能解决问题:

“愚弄我一次,应感羞愧的是你。再次愚弄我,应感羞愧的是我。”

这也是对待软件设计的态度。

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