`
xiaotao.2010
  • 浏览: 216906 次
  • 性别: Icon_minigender_1
  • 来自: 成都
社区版块
存档分类
最新评论

一些达成共识的JavaScript编码风格约定(引)

 
阅读更多

原文:http://www.iteye.com/news/28028-JavaScript-code-style-guide

 

如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低。因此,如果项目中有多人参与,采取一个有共识的编码风格约定非常有必要。与其他一些语言相比(比如Python示例),JavaScript没有一个权威的编码风格指南,取而代之的是一些流行的编码风格: 

当然,在JavaScript语法检查器JSLintJSHint中也有一些默认的设置选择。问题是,什么才是终极的、让大多数开发者可以遵循的JavaScript编码风格呢?下面让我们从这6个风格指南中找出一些有共识的风格来。

代码风格

缩进 

  • 两个空格,无需更长的缩进,无需Tab缩进:Google、NPM、Node.js、Idiomatic
  • Tab缩进:jQuery
  • 4个空格:Crockford

 参数和表达式之间的空格 

  • 使用紧凑型风格:Google、NPM、Node.js  
Js代码 
  1. project.MyClass = function(arg1, arg2) {  
  • 过多地使用空格:Idiomatic, jQuery   
Js代码 
  1. 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  
Js代码 
  1. var foo = '';  
  2. var bar = '';   
  • 一次声明多个,在行结束处使用逗号分隔:Idiomatic、jQuery 
Js代码 
  1. var foo = "",  
  2.   bar = "",  
  3.   quux;   
  • 在行开始处使用逗号:NPM
  • 没有发表意见:Google、Crockford

 大括号 

  • 在同一行使用左大括号:Google、NPM、Node.js、Idiomatic、 jQuery、Crockford 
Js代码 
  1. function thisIsBlock(){  
NPM指南中指出,只在代码块需要包含下一行时使用大括号,否则不使用。

全局变量 

  • 不要使用全局变量:Google、Crockford(谷歌表示,全局变量命名冲突难以调试,并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码,需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。)
  • 没有发表意见:Idiomatic、jQuery、NPM、Node.js

 命名风格

变量命名 

  • 开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic 
Js代码 
  1. var foo = "";  
  2. var fooName = "";  
 常量命名
  • 使用大写字母:Google、NPM、Node.js 
Js代码 
  1. var CONS = 'VALUE';   
  • 没有发表意见:jQuery、Idiomatic、Crockford

 函数命名 

  • 开始的第一个单词小写,之后的所有单词首字母大写(驼峰式):Google、NPM、Idiomatic、Node.js(推荐使用长的、具描述性的函数名) 
Js代码 
  1. function veryLongOperationName  
  2. function short()..  
      关键字形式的函数命名: 
Js代码 
  1. function isReady()  
  2. function setName()  
  3. function getName()   
  • 没有发表意见:jQuery、Crockford

 阵列命名 

  • 使用复数形式:Idiomatic  
Js代码 
  1. var documents = [];   
  • 没有发表意见:Google、jQuery、NPM、Node.js、Crockford

 对象和类命名 

  • 使用如下形式:Google、NPM、Node.js 
Js代码 
  1. 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代码编辑器将会按照它来统一项目中的所有代码风格。 

Js代码 
  1. {  
  2.   "camelcase" : true,  
  3.   "indent": 2,  
  4.   "undef"true,  
  5.   "quotmark": single,  
  6.   "maxlen": 80,  
  7.   "trailing"true,  
  8.   "curly"true  
  9. }   

此外,你应该将下面的头添加到你的JavaScript文件中。 

Js代码 
  1. /* jshint browser:true, jquery:true */   

在Node.js文件中你应该添加: 

Js代码 
  1. /*jshint node:true */   

还可以在各种JavaScript文件中添加下面的声明: 

Js代码 
  1. 'use strict';   

这将影响JSHint和你的JavaScript引擎,可能不那么兼容,但是JavaScript将会运行得更快。

在提交Git之前自动执行JSHint

如果你想确保所有的JS代码与.jshintrc中定义的风格保持一致,你可以将下面的内容添加到你的.git/hooks/pre-commit文件中,当你试图提交任何新修改的文件到项目时会自动执行风格检查。 

Js代码 
  1. #!/bin/bash  
  2. # Pre-commit Git hook to run JSHint on JavaScript files.  
  3. #  
  4. # If you absolutely must commit without testing,  
  5. # use: git commit --no-verify  
  6.    
  7. filenames=($(git diff --cached --name-only HEAD))  
  8.    
  9. which jshint &> /dev/null  
  10. if [ $? -ne 0 ];  
  11. then  
  12.   echo "error: jshint not found"  
  13.   echo "install with: sudo npm install -g jshint"  
  14.   exit 1  
  15. fi  
  16.    
  17. for i in "${filenames[@]}"  
  18. do  
  19.     if [[ $i =~ \.js$ ]];  
  20.     then  
  21.         echo jshint $i  
  22.         jshint $i  
  23.         if [ $? -ne 0 ];  
  24.         then  
  25.             exit 1  
  26.         fi  
  27.     fi  
  28. done  
分享到:
评论

相关推荐

    JavaScript_精心策划的高质量编码风格约定和标准列表.zip

    "JavaScript_精心策划的高质量编码风格约定和标准列表.zip" 文件集合很可能包含了关于编写高质量JavaScript代码的各种指南、最佳实践和工具。这个压缩包可能包括了一个或多个资源,如: 1. **说明.txt**:这可能是...

    javascript, Eventbrite JavaScript编码风格指南.zip

    javascript, Eventbrite JavaScript编码风格指南 JavaScript编码风格指南eventbrite 指南,确保JavaScript代码一致性。目标受众这个编码风格指南已经为开发人员创建,但是对于一般的JavaScript社区也很适用,而且也...

    JavaScript编码规范

    ### JavaScript编码规范详解 #### 1. 前言 随着JavaScript在前端开发中的广泛应用,尤其是在浏览器端的行为管理方面,确保代码风格的一致性对于提高团队协作效率至关重要。本篇文章旨在提供一套统一的JavaScript...

    Google JavaScript 编码规范

    **JavaScript编码风格:** 1. **命名**:变量和函数的命名应具有描述性,使用驼峰命名法(camelCase),类名使用帕斯卡命名法(PascalCase)。 2. **自定义toString()方法**:如果需要自定义`toString()`方法,请...

    Javascript 编码约定(编码规范)

    以下是一些关键的JavaScript编码约定: 1. **严格模式**:在代码的开头使用`"use strict";`声明严格模式。这将启用JavaScript的严格模式,它不允许某些可能产生错误或潜在有害的行为,从而提升代码质量。 2. **...

    Javascript编码规范

    ### JavaScript编码规范详解 #### 一、引言 随着Web技术的发展,JavaScript作为一种重要的前端脚本语言,在网页交互设计和动态效果实现上扮演着至关重要的角色。然而,由于JavaScript语言本身的特性,例如语法较为...

    富途所有项目共享的ESLint规则与JavaScript编码规范对应

    ESLint 是一个可配置的静态代码检查工具,它可以检测出语法错误、潜在的运行时错误以及不符合特定编码风格的代码。通过自定义配置,开发者可以制定自己的代码质量标准,提高团队协作效率。 2. 富途的ESLint规则 ...

    Google_JavaScript_编码规范指南.pdf

    in循环、关联数组、多行字符串、Array和Object直接量使用、with()语句、this关键字、编码风格、命名规则、自定义toString()方法、延迟初始化、明确作用域、代码格式化、括号使用、字符串可见性以及JavaScript类型和...

    javascript-obfuscatorJS编码器

    javascript-obfuscatorJS编码器

    JavaScript设计模式+JavaScript模式+JavaScript异步编程

    JavaScript模式不仅包括设计模式,还包括编码风格和最佳实践。例如: - 命名约定:遵循一致的变量、函数和类命名规则,如驼峰命名法。 - 避免全局变量污染:使用立即执行函数表达式(IIFE)或模块模式来限制作用...

    JavaScript 程序编码规范

    ### JavaScript程序编码规范详解 #### 一、引言 JavaScript是一种广泛应用的脚本语言,在现代Web开发中扮演着至关重要的角色。随着JavaScript的应用越来越广泛,编写高质量、可维护的JavaScript代码变得尤为重要。...

    javascript 编码解码(只针对英文字符)

    在这个话题中,我们将深入探讨JavaScript如何处理ASCII编码和解码,以及一些常见的编码相关函数。 首先,我们要知道ASCII(美国标准信息交换代码)是基于拉丁字母的一套电脑编码系统,它用7位二进制数表示128个字符...

    编写可维护的javascript

    《编写可维护的JavaScript》内容涵盖了编码风格、编程技巧、自动化、测试等几方面,既包括具体风格和原则的介绍,也包括示例和技巧说明,最后还介绍了如何通过自动化的工具和方法来实现一致的编程风格。, 《编写可...

    编写可维护的javascript PDF 中文完整版

    《编写可维护的JavaScript》中强调:任何语言都需要强调编码风格的一致性。只要是团队开发,每个人都以相同方式编写代码就是至关重要的。这样大家才能方便地互相看懂和维护对方的代码。运用《编写可维护的JavaScript...

    深入理解JavaScript系列

    第3部分深入探索JavaScript,介绍了语法、值、运算符、布尔类型、数字、字符串、语句、异常捕获、函数、变量、对象与继承、数组、正则表达式、Date、Math、JSON、标准全局变量、编码和JavaScript、ECMAScript 5的新...

    编写可维护的JavaScript

    任何语言都需要强调编码风格的一致性。只要是团队开发,每个人都以相同方式编写代码就是至关重要的。这样大家才能方便地互相看懂和维护对方的代码。  《编写可维护的JavaScript》向开发人员阐述了如何在团队开发中...

    JavaScript标准参考教程

    《JavaScript标准参考教程》是一本全面介绍JavaScript编程语言的书籍,其内容涵盖了从基础语法、数据类型、函数到高级特性如数组操作、错误处理、编程风格等各个方面的知识。阮一峰作为作者,将多年的经验和网络资料...

    编写可维护的javascript.pdf

    《编写可维护的JavaScript》内容涵盖了编码风格、编程技巧、自动化、测试等几方面,既包括具体风格和原则的介绍,也包括示例和技巧说明,最后还介绍了如何通过自动化的工具和方法来实现一致的编程风格。 《编写可...

    eslint-config-naver:eslint的Naver JavaScript编码约定规则

    Naver Javascript编码约定 eslint-config-naver원하는버t셋입니 원하는eslint셋입니다。 eslint-config-naver는 룰셋기준으로작성되었습니다。 eslint-config-naver 2产品。 ES6 +版本: naver ES5类别: naver/...

Global site tag (gtag.js) - Google Analytics