一些达成共识的JavaScript编码作派约定(引)

2013-07-16

一些达成共识的JavaScript编码风格约定(引)原文：http://www.iteye.com/news/28028-JavaScript-code-style-

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

原文：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 ?Js代码
  - project.MyClass?=?function(arg1,?arg2)?{??
    - 过多地使用空格：Idiomatic, jQuery ??Js代码
    - 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代码
      var?foo?=?'';??
      var?bar?=?'';???
      一次声明多个，在行结束处使用逗号分隔：Idiomatic、jQuery?Js代码
      var?foo?=?"",??
      ??bar?=?"",??
      ??quux;???
      在行开始处使用逗号：NPM
      没有发表意见：Google、Crockford
      ?大括号?
      在同一行使用左大括号：Google、NPM、Node.js、Idiomatic、?jQuery、Crockford?Js代码
      function?thisIsBlock(){??NPM指南中指出，只在代码块需要包含下一行时使用大括号，否则不使用。
      全局变量?
      不要使用全局变量：Google、Crockford（谷歌表示，全局变量命名冲突难以调试，并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码，需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。）
      没有发表意见：Idiomatic、jQuery、NPM、Node.js
      ?命名风格
      变量命名?
      开始的第一个单词小写，之后的所有单词首字母大写：Google、NPM、Node.js、Idiomatic?Js代码
      var?foo?=?"";??
      var?fooName?=?"";???常量命名
      使用大写字母：Google、NPM、Node.js?Js代码
      var?CONS?=?'VALUE';???
      没有发表意见：jQuery、Idiomatic、Crockford
      ?函数命名?
      开始的第一个单词小写，之后的所有单词首字母大写（驼峰式）：Google、NPM、Idiomatic、Node.js（推荐使用长的、具描述性的函数名）?Js代码
      function?veryLongOperationName??
      function?short()..??? ? ? 关键字形式的函数命名：?Js代码
      function?isReady()??
      function?setName()??
      function?getName()???
      没有发表意见：jQuery、Crockford
      ?阵列命名?
      使用复数形式：Idiomatic ?Js代码
      var?documents?=?[];???
      没有发表意见：Google、jQuery、NPM、Node.js、Crockford
      ?对象和类命名?
      使用如下形式：Google、NPM、Node.js?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代码编辑器将会按照它来统一项目中的所有代码风格。?
      Js代码
      {??
      ??"camelcase"?:?true,??
      ??"indent":?2,??
      ??"undef":?true,??
      ??"quotmark":?single,??
      ??"maxlen":?80,??
      ??"trailing":?true,??
      ??"curly":?true??
      }???
      此外，你应该将下面的头添加到你的JavaScript文件中。?
      Js代码
      /*?jshint?browser:true,?jquery:true?*/???
      在Node.js文件中你应该添加：?
      Js代码
      /*jshint?node:true?*/???
      还可以在各种JavaScript文件中添加下面的声明：?
      Js代码
      'use?strict';???
      这将影响JSHint和你的JavaScript引擎，可能不那么兼容，但是JavaScript将会运行得更快。
      在提交Git之前自动执行JSHint
      如果你想确保所有的JS代码与.jshintrc中定义的风格保持一致，你可以将下面的内容添加到你的.git/hooks/pre-commit文件中，当你试图提交任何新修改的文件到项目时会自动执行风格检查。?
      Js代码
      #!/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??

热点排行