编写可维护的JavaScript——读书笔记一

编码规范:制定好编码规范可以让开发团队可以更好的进行开发,发现问题。

第一章
基本的格式化

1.1缩进层级,常用的有两种,一种是tab缩进,好处是缩进层级是一对一,好辨认,还有就是编辑器可以编辑缩进的长度。坏处是有可能在不同的编辑器打开显示不同。另一种是直接使用2,4,,8个空白符来进行缩进。好处是在所有的编辑器和系统显示都是一样的。

1.2 语句结尾的分号不要省略,虽然分析器自动插入分号的机制(ASI)。使用JSlint 和JSHint可以解决这个问题。

1.3代码的长度建议在80个字符左右。太长的话,建议换行。虽然大多数风格指南没有提到这一点。

1.4换行,应该遵循的原则是缩进两个层级,在运算符后换行,防止ASI自动插入。

1.5空行,空行的作用是增加代码的可读性。没有统一的标准说应该怎么办,一般的做法是:

  • 在方法之间。
  • 在函数之间。
  • 在局部变量和一条语句之间。
  • 在多行和单行注释之前。
  • 在方法的逻辑片段之间添加空行,增加代码的可阅读性。
    1.6命名,JS语言的核心使用了小驼峰,现在有大驼峰和BEM命名法。以前的比如匈牙利命名法。比较推荐BEM命名和小驼峰命名。
    1.6.1变量的命名建议使用名称来开头,函数和方法应当使用动词例如:can,has,is,get,set。尽可能短,还有就是避免无意义的命名。
    1.6.2常量的命名可以使用全部大写,中间下划线。
    1.6.3构造函数遵循大驼峰命名法,JSlint会发出警告,如果首字母不是大写或者是构造函数没有new运算符。

1.7直接量,包括字符串,数字,布尔值,null和undefined,数组,对象等。除了布尔值比较直观之外,其它的都是要好的方式表现出来。
1.7.1字符串可以使用单引号,或者双引号。要注意从头到尾使用同一个钟。多行字符串可以使用+号链接。
1.7.2数字方面不建议省小数点之前或者之后整数部分和小数部分,避免歧义。不建议使用八进制数字写法。
1.7.3理解null的最好方式是把它当做一个对象的占位符。
1.7.4应当在代码中避免使用undefined,因为,不管是值是undefined的变量还是未声明的变量,typeof出来的结果都是undefined。
1.7.5对象中直接在在一个花括号里面写属性,而不是先声明对象,然后再另起一行写 对象.属性=“”
1.7.6数组不赞同使用array构造函数来创建数组。例如: var num = new Array(1,2,4)。推荐使用两个方括号把初始元素给括起来。

第二章
注释对于可以让代码更好的维护,毕竟很多人半年之后,看自己的代码都看不懂。好的注释可以让人读取任意部分的代码。

2.1单行注释以两个斜线 ( // )开始,以行尾结束。以下是一些好的单行注释的习惯。

  • 单行注释前空一行。
  • 好的代码缩进,跟下一行是一致。
  • 代码和注释是在同一行,注释跟代码之间有间隔。
  • 不用单行注释来注释连续多行代码。

2.2多行注释可以包裹多行文本,以/* 开始,以*/结束。多行注释好的习惯跟单行注释没有很多去吧,参考单行注释。

2.3 添加代码注释的一个原则是:使得代码变得更为清楚。个人理解是:如果使用了很新的技术,或是兼容很老的设备更是应该标记出来。
2.3.1对于难以理解的代码应该给与合适的注释。
2.3.2当代码“看上去有错误”的情况下添加注释。
2.3.3浏览器特性hack,当你为了兼容低版本的浏览器时,应该添加注释,不然有可能被误认为“错误”。
2.3.4文档注释,在代码中,添加文档,但是使用多行注释方法,注释掉。

第三章
虽然块语句可以选择是否用使用花括号。但是建议所有的块语句都应当使用花括号包裹,包括if,for,while,do…while…,try…catch…finally。

3.1花括号的对齐方式,有两种,一钟是继承自Java的左花括号放在块语句中第一季代码的结尾。第二种是随着C#放在块语句首行的下一行。

3.2块语句间隔一共有三种风格。
第一种是:字语句名,圆括号,左花括号之间没有空格间隔。
if(a>1){}
第二种是:在左圆括号之前右圆括号之后各添加一个空格。if空(a>1)空{}
第三种是:在圆括号前后各添加一个空格。if空(空a>1空)空{}

3.3 swich语句可以使用任意类型值,其他语言中必须使用原始值和常量。
3.3.1switch的缩进一个是编辑器支持的,case相对于switch缩进一个层级。另一个是case和switch同层级。
3.3.2case的连续执行,执行完一个case后连续执行一下个, 没有break是“可以接受的”,只要程序非常清晰即可。
3.3.3 default是不应该省略的,但是假如switch不想有默认行为。可以省略掉,但是应该加上注释。

3.4 with不推荐使用。

3.5 for循环有两种更改循环的方式,一种是使用break语句。另一个是continue,但是不推荐使用。

3.6 for-in是用来对实例对象和原型链中的健(key)做便利的,而不是用来便利包含数字所以的数组的。

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

推荐阅读更多精彩内容

  • 0. 写在前面 当你开始工作时,你不是在给你自己写代码,而是为后来人写代码。 —— Nichloas C. Zak...
    康斌阅读 5,321评论 1 42
  • 为什么要编写可维护的javascript? 软件生命周期80%的成本消耗在了维护上。 几乎所有的软件维护者都不是它...
    其心阅读 626评论 2 6
  • 第一部分 编程风格 "程序是写给人读的,只是偶尔让计算机运行一下" --- Donald Knuth ...
    Homary阅读 441评论 0 0
  • 二十多度的傍晚,一半晚霞的西天,沿街支起的摊子此起彼伏的叫卖声,一个背包客悄声走过,没有枯黄的梧桐叶,九月。 桌子...
    流虻阅读 255评论 0 0
  • 从小在山村长大,13岁的时候考上县城中学。从此离开山村。 所谓山村,因为真的在山上,不在平原。县城中学是民办学校,...
    中年惡爸阅读 213评论 1 0