轻松提高代码可读性,看完你也可以写出优秀代码!

轻松提高代码可读性,看完你也可以写出优秀代码!

注意:这篇文章是讲解代码可读性方面的一些写法优化,而不是指的性能优化。

下面是我总结的一份思维导图,方便形成对文章内容结构的一个大致的印象。

这节课的内容大纲

首先是关于代码优化的几条原则:

易读性优先

如果不是性能瓶颈问题,不要只是为了性能优化而改写代码

没有银弹。无论怎么写,代码的复杂性不会消失。

对于第三条,如果功能逻辑很简单,三言两语可以说清楚,那就肯定不需要几百行代码来完成,代码简简单单就可以完成了。如果你这个功能逻辑很复杂,10分钟内也没办法讲清楚的功能,那么代码也会体现出功能的复杂。

一、如何命名代码

程序员的三大难题

变量命名

缓存失效

循环边界

这里讲的是程序员的三大难题之一,变量命名。

包括两大点:

要注意词性。

注意一致性(风格统一)。

注意词性

普通变量

布尔变量命名,用「isX」或者「hasX」或者「canX」

函数变量

回调函数变量。用「介词」开头,或用「动词的现在完成时态」

这两种写法都很容易读,但是注意你最好只选择一种风格写法并保持,这也是下面将要提到的一致性。

特殊的情况 : 一些容易混淆的变量,可以添加前缀来让他们更容易读

特殊的情况 : 属性访问器函数,可以用名词

注意一致性(风格统一)

介词一致性

如果你使用了 before + after,那么就在代码的所有地方都坚持使用

如果你使用了 before + 完成时,那么就坚持使用

如果你改来改去,就「不一致」了,不一致将导致「不可预测」

顺序一致性

比如 updateContainerWidth 和 updateHeightOfContainer 的顺序就令人很别扭,同样会引发「不可预测」

表里一致性

函数名称正确的描述函数体内容,函数内容要体现函数名称,既不能多也不能少。

比如:

这就是表里不一,正确的写法是:

要么纠正函数名

要么写成两个函数

时间一致性

随着时间推移,业务的改变可能导致当初的变量名称已经不再合适,这时候要及时修改,这也是最难做到的,因为牵一发而动全身。

二、如何组织代码

现在我们的变量名称已经易读,容易理解了,之后干嘛?

是不是就剩下将你的变量组织起来了?

下面从两个经典的方法讲下如何组织你的代码

1.用函数优化你的代码

步骤:

将一坨代码放到一个函数里

将代码依赖的外部变量作为参数

将代码的输出作为函数的返回值

给函数取一个合适的名字

调用这个函数并传入参数

这个函数里的代码如果超过 5 行,则依然有优化的空间,请回到第 1 步

2.用对象组织你的代码

我们会用 this 来串联这个对象和所有函数。

还有一些需要注意的地方

一些固定套路

表驱动编程(《代码大全》里说的)

所有一一对应的关系都可以用表来做

自说明代码(以 API 参数为例)

把别人关心的东西放在显眼的位置

bad smell(坏味道)

有些代码可以用,但是很「臭」。

哪些代码是有坏味道的

表里不一的代码

过时的注释

逻辑很简单,但是看起来很复杂的代码

重复的代码

相似的代码

总是一起出现的代码

最后

做好了这几步,你的代码就可以变得更加优秀,可读性也大大提高起来。今天的前端开发工程师必备教程就讲到这里,大家如果要做开发,一定要做到一点:但凡是经过你手的代码,都会比之前好一点。

如果觉得有用,记得要关注点赞转发留言哦!

对于优化代码,你还有什么好方法吗?快留言分享下呗!

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

推荐阅读更多精彩内容

  • 第2章 基本语法 2.1 概述 基本句法和变量 语句 JavaScript程序的执行单位为行(line),也就是一...
    悟名先生阅读 4,151评论 0 13
  • 雨幕把夜色拉的深长, 滴滴答答的雨声嘈杂而响亮, 把晦暗的人的失落从头巷带到了尾巷。 / 人潮零零落落的在街道上散...
    草芥人阅读 434评论 0 0
  • 这是我人生第一次自己动手做馄饨。 为了做好这顿饭,我下午跟爸妈打了足足一个小时零十六分钟的长途电话,要准备什么材料...
    不沾板Tiffy阅读 160评论 3 3
  • 2017-12-24 姓名:李义 公司:慈溪创鑫车辆零部件有限公司 组别:259期利他二组 【知~学习】 背诵 六...
    六度轮回阅读 85评论 0 0
  • 找一个伴侣是为了什么呢,究其本质就是当身边的父母去世、朋友渐渐远去的时候,能有一个人陪你一起说话,倾听你的每件小事...
    FIONA_小fish阅读 191评论 0 0