JavaScript開發規范 降低代碼與XHTML耦合性

作為一名開發人員（WEB前端JavaScript開發），不規范的開發不僅使日後代碼維護變的困難，同時也不利於團隊的合作，通常還會帶來代碼安 全以及執行效率上的問題。本人在開發工作中就曾與不按規范來開發的同事合作過，與他合作就不能用“愉快”來形容了。現在本人撰寫此文的目的除了與大家分享 一點點經驗外，更多的是希望對未來的合作伙伴能夠起到一定的借鑒作用。當然，如果我說的有不科學的地方還希望各路前輩多多指教。下面分條目列出各種規范要 求，這些要求都是針對同事編碼毛病提出來的，好些行業約定的其它規范可能不會再提及。

1、保證代碼壓縮後不出錯

對於大型的JavaScript項目，一般會在產品發布時對項目包含的所有JavaScript文件進行壓縮處理，比如可以利用Google Closure Compiler Service對代碼進行壓縮，新版jQuery已改用這一工具對代碼進行壓縮，這一般會去掉開發時寫的注釋，除去所有空格和換行，甚至可以把原來較長的 變量名替換成短且無意義的變量名，這樣做的目的是加快文件的下載速度，同時也減小網站訪問帶來的額外數據流量，另外在代碼保護上也起到了一點點作用，至少 壓縮後的代碼即使被還原還是沒那麼容易一下讀懂的。要想代碼能正確通過壓縮，一般要求語句都要以分號正常結束，大括號也要嚴格結束等，具體還要看壓縮工具 的要求。所以如果一開始沒有按標准來做，等壓縮出錯後再回去找錯誤那是浪費時間。

2、保證代碼能通過特定IDE的自動格式化功能

一般較為完善的開發工具（比如Aptana Studio）都有代碼“自動格式”化功能，這一功能幫助實現統一換行、縮進、空格等代碼編排，你可以設置自己喜歡的格式標准，比如左大括號{是否另起一 行。達到這個要求的目的在於方便你的開發團隊成員拿你代碼的一個副本用IDE自動格式化成他喜歡或熟悉的風格進行閱讀。你同事需要閱讀你的代碼，可能是因 為你寫的是通用方法，他在其它模塊開發過程中也要使用到，閱讀你的代碼能最深入了解方法調用和實現的細節，這是簡單API文檔不能達到的效果。

3、使用標准的文檔注釋

這一要求算是最基本的，這有利於在方法調用處看到方法的具體傳參提示，也可以利用配套文檔工具生成html或其它格式的開發文檔供其他團隊成員閱 讀，你可以嘗試使用jsdoc-toolkit。如果你自動生成的API是出自一個開放平台，就像facebook.com應用，那麼你的文檔是給天下所 有開發者看的。另外編寫完整注釋，也更方便團隊成員閱讀你的代碼，通過你的參數描述，團隊成員可以很容易知道你編寫的方法傳參與實現細節。當然也方便日後 代碼維護，這樣即使再大的項目，過了很長時間後，回去改點東西也就不至於自己都忘記了當時自己寫的代碼是怎麼一回事了。

4、使用規范有意義的變量名

使用規范有意義的變量名可以提高代碼的可讀性，作為大項目開發成員，自己寫的代碼不僅僅要讓別人容易看懂。開發大項目，其實每個人寫的代碼量可能都 比較大，規范命名，日後自己看回自己的代碼也顯的清晰易懂，比如日後系統升級或新增功能，修改起代碼來也輕松多了。如果到頭發現自己當初寫的代碼現在看不 太懂了，那還真是天大的笑話了。

當然，使用有意義的變量名也盡量使用標准的命名，比如像這裡：var me = this也許沒有var self = this好，因為self是Python中的關鍵字，在Python中self就是通常語言this的用法。再看下面一個例子，加s顯然比沒有加來的科學 些，這樣可以知道這個變量名存的是復數，可能是數組等：

var li = document.getElementsByTagName('li')

var lis = document.getElementsByTagName('li')

5、不使用生偏語法

JavaScript作為一門動態腳本語言，靈活性既是優點也是缺點，眾所周知，動態語言不同層次開發人員對實現同樣一個功能寫出來的代碼在規范或語法上會存在較大的差別。不管怎麼樣，規范編碼少搞怪，不把簡單問題復雜化，不違反代碼易讀性原則才是大家應該做的。

比如這語句：typeof(b) == 'string' && alert(b)應該改為：if (typeof(b) == 'string') alert(b)，像前面那種用法，利用了&&運算符解析機制：如果檢測到&&前語句返回false就不再檢測後面語 句，在代碼優化方面也有提到把最可能出現的情況首先判斷，像這種寫法如果條件少還好，如果條件較多而且語句也長，那代碼可讀性就相當差。

又比如：+function(a){var p = a;}( 'a')應該改為：(function(a){var p = a;})( 'a')，其實function前面的+號與包含function的()括號作用是一樣的，都是起運算優先作用，後者是常見且容易看明白的防止變量污染的 做法，比如好些流行JavaScript框架就是采用後面這種方式。

再說個降低代碼可讀性的例子，如：function getPostionTxt(type){return type == 2 ? "野外" : (type == 3 ? "商城" : (type == 4 ? "副本" : null));}應該改成：function getPostionTxt(type){var typeData={"2":"野外","3":"商城","4":"副本"};if (typeData[type]) return typeData[type]; else return null;}。如果type是從0開始不間斷的整數，那麼直接使用數組還更簡單，這種結果看起來就清晰多了，看到前面那種多層三元表達式嵌套頭不暈嗎。

6、不在語句非賦值地方出生中文

語句中不應該出現中文我想一般人都知道，雖然這樣做不影響程序運行，但是顯然有背行業標准要求，當然我們也不是在使用“易語言”做開發。關於這一個 問題，我本來不想把它拿出來說的，但我確實遇到有人這樣做的，也不知道是不是因為他的英語實在太爛了，至少還可以用拼音吧，另外尋求翻譯工具幫忙也不錯的 選擇。我舉例如下，像以下寫法出現在教學中倒還可以理解：

this.user['名字'] = '張三'　或者　this.user.名字 = '張三'

7、明確定義函數固定數量的參數

固定數量參數的函數內部不使用arguments去獲取參數，因為這樣，你定義的方法如果包含較多的腳本，就不能一眼看到這個方法接受些什麼參數以及參數的個數是多少。比如像下面：

var $ = function(){return document.getElementById(arguments[0]);}應該改成：var $ = function(elemID){return document.getElementById(elemID);}

8、不必熱衷動態事件綁定

雖然知道事件可以動態綁定，比如使用addEventListener或者使用jQuery的bind方法，也知道采用動態事件綁定可以讓 XHTML更干淨，但是一般情況下我還是建議直接把事件寫在DOM節點上，我認為這樣可以使代碼變得更容易維護，因為這樣做，我們在查看源代碼的時候就可 以容易地知道什麼Element綁定了什麼方法，簡單說這樣更容易知道一個按鈕或鏈接點擊時調了什麼方法腳本。

9、降低代碼與XHTML的耦合性

不要過於依賴DOM的一些內容特征來調用不同的腳本代碼，而應該定義不同功能的方法，然後在DOM上調用，這樣不管DOM是按鈕還是鏈接，方法的調用都是一樣的，比如像下面的實現顯然會存在問題：

function myBtnClick(obj)

{

if (/確定/.test(obj.innerHTML)) 

alert('OK');

else if (/取消/.test(obj.innerHTML)) 

alert('Cancel');

else 

alert('Other');

}

<a herf="javascript:;" onclick="myBtnClick(this)">確定</a><a herf="javascript:;" onclick="myBtnClick(this)">取消</a>

上面例子其實在一個函數內處理了兩件事情，應該分成兩個函數，像上面的寫法，如果把鏈接換成按鈕，比如改成這樣：<input type="button" onclick="myBtnClick(this)" value="確定" />，那麼myBtnClick函數內部的obj.innerHTML就出問題了，因為此時應該obj.value才對，另外如果把按鈕名稱由中文 改為英文也會出問題，所以這種做法問題太多了。

10、一個函數應該返回統一的數據類型

因為JavaScrip是弱類型的，在編寫函數的時候有些人對於返回類型的處理顯得比較隨便，我覺得應該像強類型語