一些达成共识的JavaScript编码风格约定
如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低。因此,如果项目中有多人参与,采取一个有共识的编码风格约定非常有必要。与其他一些语言相比(比如Python示例),JavaScript没有一个权威的编码风格指南,取而代之的是一些流行的编码风格:
- Google的JavaScript风格指南(以下简称Google)
- NPM编码风格(以下简称NPM)
- Felix的Node.js风格指南(以下简称Node.js)
- 惯用(Idiomatic)的JavaScript(以下简称Idiomatic)
- jQuery JavaScript风格指南(以下简称jQuery)
- Douglas Crockford的JavaScript风格指南(以下简称Crockford),Douglas Crockford是Web开发领域最知名的技术权威之一,ECMA JavaScript 2.0标准化委员会委员
当然,在JavaScript语法检查器JSLint和JSHint中也有一些默认的设置选择。问题是,什么才是终极的、让大多数开发者可以遵循的JavaScript编码风格呢?下面让我们从这6个风格指南中找出一些有共识的风格来。
代码风格
缩进
- 两个空格,无需更长的缩进,无需Tab缩进:Google、NPM、Node.js、Idiomatic
- Tab缩进:jQuery
- 4个空格:Crockford
参数和表达式之间的空格
- 使用紧凑型风格:Google、NPM、Node.js
- 过多地使用空格:Idiomatic, jQuery
没有发表意见:Crockford
大部分指南中,都提醒开发者不要在语句结尾处有任何的空格。
代码行长度
- 最多80个字符:Google、NPM、Node.js、Crockford(当在代码块中,除了2个空格外的其他缩进允许将函数参数与首个函数参数的位置对齐。另一种选择是当自动换行时使用4个空格缩进,而不是2个。)
- 没有发表意见:jQuery、Idiomatic
分号
- 始终使用分号,不依赖于隐式插入:Google、Node.js、Crockford
- 在某些情况下不要使用expect:NPM
- 没有发表意见:jQuery、Idiomatic
注释
- 遵循JSDoc约定:Google、Idiomatic
- 没有发表意见:NPM、Node.js、jQuery、Crockford
引号
- 推荐单引号:Google、Node.js
- 双引号:jQuery
- 没有发表意见:NPM、Idiomatic、Crockford
变量声明
- 一次声明一个,不使用逗号:Node.js
- 一次声明多个,在行结束处使用逗号分隔:Idiomatic、jQuery
- 在行开始处使用逗号:NPM
- 没有发表意见:Google、Crockford
大括号
- 在同一行使用左大括号:Google、NPM、Node.js、Idiomatic、 jQuery、Crockford
NPM指南中指出,只在代码块需要包含下一行时使用大括号,否则不使用。
全局变量
- 不要使用全局变量:Google、Crockford(谷歌表示,全局变量命名冲突难以调试,并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码,需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。)
- 没有发表意见:Idiomatic、jQuery、NPM、Node.js
命名风格
变量命名
- 开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic
常量命名
- 使用大写字母:Google、NPM、Node.js
- 没有发表意见:jQuery、Idiomatic、Crockford
函数命名
- 开始的第一个单词小写,之后的所有单词首字母大写(驼峰式):Google、NPM、Idiomatic、Node.js(推荐使用长的、具描述性的函数名)
关键字形式的函数命名:
- 没有发表意见:jQuery、Crockford
阵列命名
- 使用复数形式:Idiomatic
- 没有发表意见:Google、jQuery、NPM、Node.js、Crockford
对象和类命名
- 使用如下形式:Google、NPM、Node.js
【一些达成共识的JavaScript编码风格约定】相关文章
5. 微软与Google达成JavaScript框架合作:将共同打造Angular 2
8. JScrambler:保护你的JavaScript代码
9. Facebook将与FTC达成和解 或为明年上市IPO准备
10. 腾讯微博、AppCan达成战略合作 提供跨平台开发服务
本文来源:https://www.51html5.com/a3303.html
﹝一些达成共识的JavaScript编码风格约定﹞相关内容
- 原生体验挡不住!JavaScript开源跨平台框架NativeScript
- JavaScript开源跨平台框架NativeScript
- RapydScript:将特定代码转换成JavaScript的预编译器
- JavaScript大师Nicholas C. Zakas谈TypeScript
- CoffeeScript 已死,CoffeeScript 万岁!
- [科普文] 关于浏览器内核的一些小知识,明明白白选浏览器
- 你需要知道HTML5的一些事
- 你需要知道HTML5的一些事
- 在编程中常见的一些英语词汇
- 一款帮助你生成非常有趣的扇形扑克牌风格特效的jQuery插件-Baraja ...