当前流行的JavaScript代码风格指南


JavaScript 没有一个权威的编码风格指南,取而代之的是一些流行的编码风格:

http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
NPM编码风格(以下简称NPM)
https://npmjs.org/doc/coding-style.html
Felix的Node.js风格指南(以下简称Node.js)
http://nodeguide.com/style.html
惯用(Idiomatic)的JavaScript(以下简称Idiomatic)
https://github.com/rwldrn/idiomatic.js/
jQuery JavaScript风格指南(以下简称jQuery)
http://contribute.jquery.org/style-guide/js/
Douglas Crockford的JavaScript风格指南(以下简称Crockford),Douglas Crockford是Web开发领域最知名的技术权威之一,ECMA JavaScript 2.0标准化委员会委员
http://javascript.crockford.com/code.html

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

1. 代码风格比较

1.1 缩进

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

1.2 参数和表达式之间的空格

使用紧凑型风格:Google、NPM、Node.js

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 将会运行得更快。

4. 在提交 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




« 
» 

Copyright © 2016 phpStudy | 豫ICP备2021030365号-3