代码质量修炼之路 - 读《代码整洁之道》有感

代码和代码之间是存在差距的,即使实现的功能相同。读一份好的代码,我们可以清晰的感觉到作者的思路、想法。作为一个刚入行的菜鸟,我的代码质量总是会被mentor点名,codereview时总会收到很多comments。那如何提高自己的代码姿势水平呢,这里倾情推荐一本书《clean code》(《代码整洁之道》)。接下来,我会分享一下我从这本书中的收获以及我日常coding中的一些个人总结。

命名

命名实在是代码中最基础也是最重要的一环。一份代码,从阅读上来讲,无非是一堆命名+一些固定的语法。命名的好坏直接决定了程序的可读性。那什么样的命名才算是好的命名呢?我觉得可以用严复先生的「信达雅」三字来概括。

  • 信就是命名要准确的表达实际的意义、不偏离、不遗漏、也不要随意增减意思。比如:d1,d2就是很糟糕的命名,monday、tuesday就是良好的命名
  • 达就是命名要通顺明白,《clean code》中也建议尽量使用能够读得出来的名称。rBd和requestBaidu相比,明显后者通顺明白
  • 雅就是优雅,这是比较玄学的一部分。比如一个方法是执行一个动作,那么命名最好是一个动词词组。

函数

函数在程序中的重要性无须多表。要写好一个函数要做好两件事情:概括与分段(很像语文老师常念叨的事情)。
首先,函数不能长篇大论,函数应该尽量短小,没人希望看到鸿篇巨制。短小就要求函数尽量专注于一件事,如果你发现函数内部代码代码太多,完成的功能超过两件,那么你就应该考虑把一部分代码分块抽象成另外一个函数。
其次,函数内部应该做到良好的分段,逻辑和功能上联系紧密的代码语句应该放在一起,两个代码段之间可以使用空行分隔,这样代码阅读者可以很轻松的知道代码的结构
最后,解决重复。如果一个功能在多个地方都有使用,那么我们应该写一份代码被多个地方引用,而不是在多个地方写多份代码。这样有几个好处,能够缩短代码工作量,更好的封装功能模块。同时也会对后期的维护升级带来巨大的好处,只需要维护一份代码,一处修改、处处受益。

注释

《clean code》一书中对注释的看法改变了我对注释的使用。
以前在我看来,注释是一个非常好用的东西,可以帮助别人理解程序,拥有比代码好得多的表达性。有的框架标准甚至要求对每一个函数进行特定格式的注释。
但是,在《clean code》的作者看来,注释并不是『纯然的好』,甚至可以说是「必然的恶」。写注释就意味着用代码表达意图时的失败,如果代码写的足够好,表达足够清晰,那么注释完全是没有必要的。
同时,大家要记住,在程序中,唯有代码是真实可靠的,注释是可能会与真实代码不一致的,是可能会撒谎的。有的人可能会说,怎么会,我的注释都是照着代码写的,绝对是表达的我本来的意思。但是大家忘了,代码是在变动的,你会升级、迁移、甚至完全改造你的函数,但是你可能很久都不会维护你的注释。因此,在未来的某一个时间点,你的注释和你的代码之间就出现了代沟,阅读你代码的人就会很困惑。
因此,注释是不必要的、是会给你带来维护成本的一个负担。如果有可能,尽量使用优秀的代码表达你的意思,而不是使用注释。

格式

大家都很熟悉格式,写作文时每段开头空两格。统一规范总是给人赏心悦目的感觉。因此,保持统一规范的格式,良好的缩进、换行,对于代码的美观是非常重要的。

总结

如果你能做到以上这些点,那么我相信你一定能够写出一份良好的代码!

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,095评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,654评论 18 139
  • 物流信息上显示您的快递已被合作便利店签收,林夕决定拖着两条早已不耐烦的腿绕着小区走一圈,看还有没有快递点没关门,去...
    shaelin阅读 186评论 4 2
  • 今天我期待已久的小仓鼠终于到了,我开心又兴奋。我打开一看里面有一只白色的小仓鼠和一只黄色的小仓鼠。它们非常的活...
    大王雅婷阅读 221评论 0 0