作為一名開發人員（We前端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') 

it知識庫：JavaScript 開發規范要求，轉載需保留來源！

鄭重聲明：本文版權歸原作者所有，轉載文章僅為傳播更多信息之目的，如作者信息標記有誤，請第一時間聯系我們修改或刪除，多謝。