编写可读性代码

脏话的频率是衡量代码好坏的标准

一、代码应该易于理解

可读性定理

别人理解它的时间最小化
并不是意味着代码块越小理解时间越短,有时候短的代码可能花费更多的时间去让被人理解。

理解代码所需要的时间是否与其他目标冲突。

如良好的架构,易于测试。并不冲突。因为易于理解的代码往往可以引向良好的架构和测试。

二、表面层次的改进

2.1、把信息装进名字里

名字就是一个小小的注释

1、选择专业名词

比如:getPage(url)这个方法名get就用的就比较不专业。我们无法得知他是从本地缓存取的网页还是从互联网。如果是从互联网,可以使用fetch,或者download。

再比如,在写树的方法时候,我们用size()表达树的高度,但是在阅读时人们可能会产生疑惑,这个方法是得到树的节点数吗,于是得详细阅读代码才能知道这个代码是用来获取什么。是不是使用height()的方法名表意更清楚呢,如果想获得节点数,就使用NumNodes()方法名来表示。
那么,如何选择专业名词呢。
找到更有表现力的词

image.png
2、避免使用泛泛的名字
3、用具体的名字代替抽象的名字
4、使用前缀或后缀给名字附加更多信息
5、决定名字长度

在小作用域里可以使用短名字

6、利用名字格式表达含义

2.2、代码的审美

代码采用好的审美可以提高代码的可读性,包括

1、可以重新安排换行,让相似的代码看起来尽可能相似
2、如果换行让代码依旧毫无美感,可以将相似的代码提炼到一个方法里
3、在需要时使用列对齐,如果不是那么费功夫的话。
4、选一个有意义的顺序,至始至终保持他。
5、可以把代码的声明按逻辑分组。
6、把代码分成段落,用空行隔开。
7、保持个人风格的一致。

三、简化循环

3.1、让控制流变得易读

1、注意条件语句参数的顺序。

通常来说,被询问的是放在左侧

2、最小化嵌套

方式:1.使用continue 2、使用提早返回

3、减少让可读性变差的三目运算符、goto语句

3.2、拆分超长的表达式

1、引用解释变量
2、使用摩根定理重写代码

3.3、变量与可读性

1、减少变量和中间结果
2、缩小变量作用域
3、只写一次变量,让代码更容易理解

四、重新组织代码

4.1、抽取不相干的子问题

1、创建通用代码、自底向上编码
2、简化已有接口或重塑接口

4.2、代码只做一件事

4.3、用自然语言描述代码

4.4、少些代码

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

推荐阅读更多精彩内容