一、避免污染全域命名空間
應始終把程式碼包在一個立即呼叫的函式表達式中,形成獨立的模組。
不建議
var x = 10, y = 100; console.log(window.x + ' ' + window.y);
建議
;(function(window){ 'use strict'; var x = 10, y = 100; console.log(window.x + ' ' + window.y); }(window));
二、立即執行函式
在立即執行函式中,若用到了全域變數,應透過傳參的方式傳入,讓函式體在呼叫時能以區域變數的形式使用,某種程度上能提升效能。
此外,應在立即執行函式的參數列表最後加上 undefined,這是因為在 ES3 裡 undefined 是可讀寫的,一旦全域的 undefined 被改動,你的程式碼就可能得到不如預期的結果。
另外,建議在立即執行函式的開頭與結尾都加上分號,避免合併檔案時因他人的程式碼不規範而影響到我們。
不建議
(function(){ 'use strict'; var x = 10, y = 100, c, elem=$('body'); console.log(window.x + ' ' + window.y); $(document).on('click',function(){ }); if(typeof c==='undefined'){ //你的程式碼 } }());
建議
;(function($,window,document,undefined){ 'use strict'; var x = 10, y = 100, c, elem=$('body'); console.log(window.x + ' ' + window.y); $(document).on('click',function(){ }); if(typeof c==='undefined'){ //你的程式碼 } }(jQuery,window,document));
三、嚴格模式
ECMAScript 5 的嚴格模式可在整個腳本或單一方法內啟用,它會對不同的 JavaScript 語境做更嚴格的錯誤檢查,讓程式碼更健壯、執行也更有效率,同時能避免誤用未來可能引入的保留字。
建議在獨立的立即執行函式中啟用嚴格模式,而不要在腳本第一行就啟用,以免導致所有腳本都進入嚴格模式,進而引發某些第三方函式庫的問題。
不建議
'use strict'; (function(){ }());
建議
(function(){ 'use strict'; }());
四、變數宣告
所有變數宣告都應明確指定 var,否則在嚴格模式下會報錯;同一作用域內的變數最好用一個 var 一次宣告,多個變數以逗號分隔。
不建議
function myFun(){ x=5; y=10; }
部分建議
function myFun(){ var x=5; var y=10; }
建議
function myFun(){ var x=5, y=10; }
五、使用帶型別判斷的比較運算子
應使用 === 精確比較運算子,避免在判斷過程中因 JavaScript 的強制型別轉換而產生困擾。使用 === 時,比較的雙方必須同型別才會成立。
不建議
(function(w){ 'use strict'; w.console.log('0' == 0); // true w.console.log('' == false); // true w.console.log('1' == true); // true w.console.log(null == undefined); // true var x = { valueOf: function() { return 'X'; } }; w.console.log(x == 'X');//true }(window));
建議
(function(w){ 'use strict'; w.console.log('0' === 0); // false w.console.log('' === false); // false w.console.log('1' === true); // false w.console.log(null === undefined); // false var x = { valueOf: function() { return 'X'; } }; w.console.log(x === 'X');//false }(window));
六、變數賦值時的邏輯運算
邏輯運算子 || 與 && 也可用來回傳布林值。若運算物件為非布林值,每個運算式會由左而右進行真假判斷,最終總會有一個運算式被回傳。善用這個特性,可以用來精簡賦值程式碼。
不建議
if(!x) { if(!y) { x = 1; } else { x = y; } }
建議
x = x || y || 1;
七、分號
應始終使用分號,因為隱式的程式碼串接會引發難以察覺的問題。以下幾個範例說明了缺少分號的潛在危害:
// 1. MyClass.prototype.myMethod = function() { return 42; } //這裡沒有分號 (function() { })(); //2. var x = { 'i': 1, 'j': 2 } // 這裡沒有分號 [ffVersion, ieVersion][isIE](); // 3. var THINGS_TO_EAT = [apples, oysters, sprayOnCheese] // 這裡沒有分號 -1 == resultOfOperation() || die();
錯誤結果
1. JavaScript 錯誤——先回傳 42 的那個函式會被第二個函式當成參數傳入呼叫,接著數字 42 又被「呼叫」而導致出錯。
2. 你很可能會得到「no such property in undefined」的錯誤,因為實際上的呼叫變成了 xffVersion, ieVersion()。
3. die 總是會被呼叫。因為陣列減 1 的結果是 NaN,它不等於任何值(無論 resultOfOperation 是否回傳 NaN),最終 die() 執行後的結果會被賦給 THINGS_TO_EAT。
八、區塊內的函式宣告
切勿在語句區塊內宣告函式,在 ECMAScript 5 的嚴格模式下這是不合法的。函式宣告應放在作用域的頂層;若要在區塊內使用,可改為將函式表達式賦值給變數。
不建議
if (x) { function foo() {} }
建議
if (x) { var foo = function() {}; }
九、避免使用 eval
eval() 不僅會混淆語境,還潛藏風險,通常都有更清晰、更安全的替代方案,因此盡量不要使用 eval。
十、陣列與物件字面量
1. 用陣列與物件字面量取代構造器。陣列構造器很容易在參數上出錯。
不建議
//陣列長度 3 var a1 = new Array(x1, x2, x3); //陣列長度 2 var a2 = new Array(x1, x2); //若 x1 是自然數,長度將為 x1;若不是自然數,長度則為 1 var a3 = new Array(x1); var a4 = new Array();
正因如此,若把傳參從兩個改成一個,陣列長度很可能發生意料之外的變化。為避免這類狀況,請一律採用可讀性高的陣列字面量。
建議
var a = [x1, x2, x3]; var a2 = [x1, x2]; var a3 = [x1]; var a4 = [];
2. 物件構造器雖無類似問題,但為了可讀性與一致性,也應採用物件字面量。
不建議
var o = new Object(); var o2 = new Object(); o2.a = 0; o2.b = 1; o2.c = 2; o2['strange key'] = 3;
建議
var o = {}; var o2 = { a: 0, b: 1, c: 2, 'strange key': 3 };
十一、三元條件運算子(if 的簡寫)
在較簡單的情況下可用三元運算子來賦值或回傳,避免在複雜情境下濫用,否則沒人願意被十行三元運算式繞暈。
不建議
if(x === 10) { return 'valid'; } else { return 'invalid'; }
建議
return x === 10 ? 'valid' : 'invalid';
十二、for 迴圈
使用 for 迴圈時,建議先用一個變數存好陣列長度,如此能提升執行效率,而不必每次迭代都重新計算長度。
不建議
for(var i=0;i<arr.length;i++){ }
建議
for(var i=0,len=arr.length;i<len;i++){ }
十三、重複的 DOM 操作
對於重複的 DOM 操作,用一個變數來接收結果相當有必要,而不是頻繁地去操作 DOM 樹,這對效能與程式碼的整潔、易維護性都有幫助。
不建議
$('.myDiv').find('.span1').text('1'); $('.myDiv').find('.span2').text('2'); $('.myDiv').find('.span3').text('3'); $('.myDiv').find('.span4').text('4');
建議
var mydiv=$('.myDiv'); mydiv.find('.span1').text('1'); mydiv.find('.span2').text('2'); mydiv.find('.span3').text('3'); mydiv.find('.span4').text('4');
在可使用 jquery .end() 的情況下,應優先使用 .end():
$('.myDiv').find('.span1').text('1') .end().find('.span2').text('2') .end().find('.span3').text('3') .end().find('.span4').text('4');
十四、註解規範
撰寫註解時,建議採用格式化且統一的風格,並盡量描述寫程式時的思路,而不是單純複述程式碼做了什麼。
不建議
//取得訂單 function getOrderByID(id){ var order; //... return order; }
方法的註解應統一採用區塊註解。
建議
/** * 根據訂單 id 取得訂單詳細資料 * @param {[number]} id [訂單 ID] * @return {[order]} [訂單詳細資訊] */ function getOrderByID(id){ var order; //... return order; }
總結
以上就是 JavaScript 常用程式碼撰寫規範的整理,內容相當全面,對大家撰寫或學習 JavaScript 具有一定的參考價值,若有疑問歡迎留言交流。