一些達成共識的JavaScript編碼風格約定

csdn發表於2013-07-12
JavaScript

　　如果你的程式碼易於閱讀，那麼程式碼中bug也將會很少，因為一些bug可以很容被除錯，並且，其他開發者參與你專案時的門檻也會比較低。因此，如果專案中有多人蔘與，採取一個有共識的編碼風格約定非常有必要。與其他一些語言相比（比如Python示例），JavaScript沒有一個權威的編碼風格指南，取而代之的是一些流行的編碼風格：

　　當然，在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(){

　　NPM指南中指出，只在程式碼塊需要包含下一行時使用大括號，否則不使用。

　　全域性變數

  • 不要使用全域性變數：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, the winning style

相關文章