编写可维护的JS

永远的偶像-孙悟空

0.

当你开始工作时,你不是在给你自己写代码,而是为后来人写代码。 —— Nichloas C. Zakas

本文主要是《编写可维护的JS》的读书笔记,和博客大牛的内容,以便自己在开发中也以这样的方式来要求代码,不像以前只单个考虑,现在是整体考虑。作者写这本书的时候(大概2012-2013年)ES6还没出来,考虑到当前MV*时代下,大家几乎都在写ES6,所以本文会针对ES6作特别说明(原书内容针对ES5)。原书作者结合自己的工作经验(2006年开始在雅虎为期5年的工作)写出了这本书,作者在书中浓墨重彩强调的东西,我们现在看来都稀疏平常(如:为什么需要禁用with和eval,为什么始终使用===和!==进行比较),在这些内容上我会一笔带过,假定你已经熟知这些基本常识了。

我们知道JS语言有着先天的设计缺陷(ES6之后才好转了不少),如何不刻意学习如何编写优质易维护的代码,你很容易就写出糟糕的代码(虽然它可以运行)。

  • 关于代码的维护,你需要明白以下四点:
  • 软件生命周期中80%的成本消耗在了维护上。
  • 几乎所有的软件维护者都不是它的最初作者。
  • 编码规范提高了软件的可读性,它让工程师能够快速且充分地理解新的代码。
    如果你将源码作为产品来发布,你需要确保它是可完整打包的,且像你创建的其他产品一样整洁。
    对的,你写的代码很大概率上,并不是由你来维护的。因为你可能换公司了,可能去做新项目了,也可能你压根就不记得这段代码是你六个月前写的。所以,不要抱着“我就是来搬砖的,随便写写,改不动了就溜了”的态度来写代码,相信读者你也维护过别人写的代码,吐槽过那难以理解没有任何注释的代码,恨不得把写那代码的人拉过来打一顿。所以,请不要成为你所讨厌的人。编写出可维护的代码,既是职业素养的问题,也是你专业精神的体现。

学习了作者:康斌他的链接:https://www.jianshu.com/p/bd4ae4a61af3

关于如何编写可维护的JS,我将从 编程风格编程实践工程化 三个方面进行阐述。

程序是写给人读的,只是偶尔让计算机执行一下。 —— Donald Knuth

我们会经常碰到这两个术语:“编程风格”(style guideline)和“编码规范”(code convention)。编程风格是编码规范的一种,用来规约单文件中代码的规划。编码规范还包括编程最佳实践、文件和目录的规划以及注释等方面。本文集中讨论JS的编码规范。

为什么要讨论编程风格?每个人都有自己偏爱的编程风格,但更多的时候我们是作为团队一员进行协作开发的,统一风格十分重要,因为它会促成团队成员高水准的协作(所有的代码看起来极为类似)。毫无疑问,全球性的大公司都对外或者对内发布过编程风格文档,如:Airbnb JavaScript Style Guide, Google JavaScript Style Guide等,你若仔细阅读会发现它们很多规范都是相同的,只是部分细节略有差异。

在某些场景中,很难说哪种编程风格好,哪种编程风格不好,因为有些编程风格只是某些人的偏好。本文并不是向你灌输我个人的风格偏好,而是提炼出了编程风格应当遵循的重要的通用规则。

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

推荐阅读更多精彩内容