原文:http://www.iteye.com/news/28028-JavaScript-code-style-guide
如果你的代码易于阅读,那么代码中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
- project.MyClass = function(arg1, arg2) {
- 过多地使用空格:Idiomatic, jQuery
- for ( i = 0; i < length; i++ ) {
- 没有发表意见: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
- var foo = '';
- var bar = '';
- 一次声明多个,在行结束处使用逗号分隔:Idiomatic、jQuery
- var foo = "",
- bar = "",
- quux;
- 在行开始处使用逗号:NPM
- 没有发表意见:Google、Crockford
大括号
- 在同一行使用左大括号:Google、NPM、Node.js、Idiomatic、 jQuery、Crockford
- function thisIsBlock(){
全局变量
- 不要使用全局变量:Google、Crockford(谷歌表示,全局变量命名冲突难以调试,并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码,需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。)
- 没有发表意见:Idiomatic、jQuery、NPM、Node.js
命名风格
变量命名
- 开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic
- var foo = "";
- var fooName = "";
- 使用大写字母:Google、NPM、Node.js
- var CONS = 'VALUE';
- 没有发表意见:jQuery、Idiomatic、Crockford
函数命名
- 开始的第一个单词小写,之后的所有单词首字母大写(驼峰式):Google、NPM、Idiomatic、Node.js(推荐使用长的、具描述性的函数名)
- function veryLongOperationName
- function short()..
- function isReady()
- function setName()
- function getName()
- 没有发表意见:jQuery、Crockford
阵列命名
- 使用复数形式:Idiomatic
- var documents = [];
- 没有发表意见:Google、jQuery、NPM、Node.js、Crockford
对象和类命名
- 使用如下形式:Google、NPM、Node.js
- var ThisIsObject = new Date;
- 没有发表意见:jQuery、Idiomatic、Crockford
其他命名
- 针对长文件名和配置键使用all-lower-hyphen-css-case形式:NPM
根据上述风格来配置.jshintrc文件
JSHint(http://www.jshint.com/)是一个JavaScript语法和风格检查工具,你可以用它来提醒代码风格相关的问题。它可以很好地被集成到许多常用的编辑器中,是统一团队编码风格的一个很好的工具。
你可以通过JSHint文档查看可用的选项:http://www.jshint.com/docs/#options
下面根据本文上面每个分类下的第一种风格来创建一个.jshintrc文件。你可以将它放到项目中根目录中,JSHint-avare代码编辑器将会按照它来统一项目中的所有代码风格。
- {
- "camelcase" : true,
- "indent": 2,
- "undef": true,
- "quotmark": single,
- "maxlen": 80,
- "trailing": true,
- "curly": true
- }
此外,你应该将下面的头添加到你的JavaScript文件中。
- /* jshint browser:true, jquery:true */
在Node.js文件中你应该添加:
- /*jshint node:true */
还可以在各种JavaScript文件中添加下面的声明:
- 'use strict';
这将影响JSHint和你的JavaScript引擎,可能不那么兼容,但是JavaScript将会运行得更快。
在提交Git之前自动执行JSHint
如果你想确保所有的JS代码与.jshintrc中定义的风格保持一致,你可以将下面的内容添加到你的.git/hooks/pre-commit文件中,当你试图提交任何新修改的文件到项目时会自动执行风格检查。
- #!/bin/bash
- # Pre-commit Git hook to run JSHint on JavaScript files.
- #
- # If you absolutely must commit without testing,
- # use: git commit --no-verify
- filenames=($(git diff --cached --name-only HEAD))
- which jshint &> /dev/null
- if [ $? -ne 0 ];
- then
- echo "error: jshint not found"
- echo "install with: sudo npm install -g jshint"
- exit 1
- fi
- for i in "${filenames[@]}"
- do
- if [[ $i =~ \.js$ ]];
- then
- echo jshint $i
- jshint $i
- if [ $? -ne 0 ];
- then
- exit 1
- fi
- fi
- done
相关推荐
"JavaScript_精心策划的高质量编码风格约定和标准列表.zip" 文件集合很可能包含了关于编写高质量JavaScript代码的各种指南、最佳实践和工具。这个压缩包可能包括了一个或多个资源,如: 1. **说明.txt**:这可能是...
javascript, Eventbrite JavaScript编码风格指南 JavaScript编码风格指南eventbrite 指南,确保JavaScript代码一致性。目标受众这个编码风格指南已经为开发人员创建,但是对于一般的JavaScript社区也很适用,而且也...
### Google JavaScript 编码规范指南解析 #### 一、概览与重要性 Google的JavaScript编码规范指南,作为Google内部及开源项目中的编程标准,旨在提高代码的可读性、可维护性和一致性。遵循这套规范,能够帮助...
### JavaScript程序编码规范 #### 一、概述 《JavaScript程序编码规范》是一份旨在提高JavaScript代码质量和可维护性的指南。该规范由Douglas Crockford编写,并由cloudwater翻译成中文版。Crockford是一位著名的...
### JavaScript编码规范详解 #### 1. 前言 随着JavaScript在前端开发中的广泛应用,尤其是在浏览器端的行为管理方面,确保代码风格的一致性对于提高团队协作效率至关重要。本篇文章旨在提供一套统一的JavaScript...
**JavaScript编码风格:** 1. **命名**:变量和函数的命名应具有描述性,使用驼峰命名法(camelCase),类名使用帕斯卡命名法(PascalCase)。 2. **自定义toString()方法**:如果需要自定义`toString()`方法,请...
### JavaScript程序编码规范详解 #### 一、引言 在软件开发领域,代码的质量直接影响着项目的长期维护性和可扩展性。良好的编码规范不仅能够提升代码的可读性,还能够帮助团队成员更快地理解和协作。《JavaScript...
资源名称:Javascript编码规范 资源截图: 资源太大,传百度网盘了,链接在附件中,有需要的同学自取。
### Google JavaScript编码规范指南 #### 一、概述 Google JavaScript编码规范指南旨在为开发者提供一套标准的编程准则,帮助提高代码质量与可维护性。本文档详细介绍了在编写JavaScript项目时应该遵循的最佳实践...
9. JavaScript类型注释和编译提示:这部分可能会涉及如何在JavaScript代码中使用注释来指明变量类型,以及编码过程中的一些技巧和提示。 10. JavaScript的编码实践:比如Array和Object直接量的使用,以及with() {}...
### JavaScript编码规范详解 #### 一、引言 随着Web技术的发展,JavaScript作为一种重要的前端脚本语言,在网页交互设计和动态效果实现上扮演着至关重要的角色。然而,由于JavaScript语言本身的特性,例如语法较为...
以下是一些核心的JavaScript编码规范: 1. **包名**:应全为小写,避免使用多个单词组合。 2. **类名**:必须是名词,采用UpperLowerCase(驼峰式)命名法。 3. **方法名**:应为动词或动词短语,同样采用...
JavaScript编码与解码是Web开发中的重要组成部分,它涉及到字符集、编码格式以及字符串处理等多个方面。在这篇文章中,我们将深入探讨JavaScript中的编码与解码机制,并结合标签“源码”和“工具”来理解其在实际...
《编写可维护的JavaScript》内容涵盖了编码风格、编程技巧、自动化、测试等几方面,既包括具体风格和原则的介绍,也包括示例和技巧说明,最后还介绍了如何通过自动化的工具和方法来实现一致的编程风格。, 《编写可...
《编写可维护的JavaScript》中强调:任何语言都需要强调编码风格的一致性。只要是团队开发,每个人都以相同方式编写代码就是至关重要的。这样大家才能方便地互相看懂和维护对方的代码。运用《编写可维护的JavaScript...
第3部分深入探索JavaScript,介绍了语法、值、运算符、布尔类型、数字、字符串、语句、异常捕获、函数、变量、对象与继承、数组、正则表达式、Date、Math、JSON、标准全局变量、编码和JavaScript、ECMAScript 5的新...
与C/C++和Java等语言相比,JavaScript的灵活语法可能会导致一些开发者不重视编码规范,但这恰恰是需要改进的地方。通过遵守明确的编码规范,不仅可以减少开发过程中遇到的问题,还可以提升软件产品的质量,最终促进...
任何语言都需要强调编码风格的一致性。只要是团队开发,每个人都以相同方式编写代码就是至关重要的。这样大家才能方便地互相看懂和维护对方的代码。 《编写可维护的JavaScript》向开发人员阐述了如何在团队开发中...