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

　　1、保證代碼壓縮后不出錯(cuò)

　　對于大型的JavaScript項(xiàng)目，一般會(huì)在產(chǎn)品發(fā)布時(shí)對項(xiàng)目包含的所有JavaScript文件進(jìn)行壓縮處理，比如可以利用Google Closure Compiler Service對代碼進(jìn)行壓縮，新版jQuery已改用這一工具對代碼進(jìn)行壓縮，這一般會(huì)去掉開發(fā)時(shí)寫的注釋，除去所有空格和換行，甚至可以把原來較長的變量名替換成短且無意義的變量名，這樣做的目的是加快文件的下載速度，同時(shí)也減小網(wǎng)站訪問帶來的額外數(shù)據(jù)流量，另外在代碼保護(hù)上也起到了一點(diǎn)點(diǎn)作用，至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。要想代碼能正確通過壓縮，一般要求語句都要以分號正常結(jié)束，大括號也要嚴(yán)格結(jié)束等，具體還要看壓縮工具的要求。所以如果一開始沒有按標(biāo)準(zhǔn)來做，等壓縮出錯(cuò)后再回去找錯(cuò)誤那是浪費(fèi)時(shí)間。

　　2、保證代碼能通過特定IDE的自動(dòng)格式化功能

　　一般較為完善的開發(fā)工具（比如Aptana Studio）都有代碼“自動(dòng)格式”化功能，這一功能幫助實(shí)現(xiàn)統(tǒng)一換行、縮進(jìn)、空格等代碼編排，你可以設(shè)置自己喜歡的格式標(biāo)準(zhǔn)，比如左大括號{是否另起一行。達(dá)到這個(gè)要求的目的在于方便你的開發(fā)團(tuán)隊(duì)成員拿你代碼的一個(gè)副本用IDE自動(dòng)格式化成他喜歡或熟悉的風(fēng)格進(jìn)行閱讀。你同事需要閱讀你的代碼，可能是因?yàn)槟銓懙氖峭ㄓ梅椒ǎ谄渌K開發(fā)過程中也要使用到，閱讀你的代碼能最深入了解方法調(diào)用和實(shí)現(xiàn)的細(xì)節(jié)，這是簡單API文檔不能達(dá)到的效果。

　　3、使用標(biāo)準(zhǔn)的文檔注釋

　　這一要求算是最基本的，這有利于在方法調(diào)用處看到方法的具體傳參提示，也可以利用配套文檔工具生成html或其它格式的開發(fā)文檔供其他團(tuán)隊(duì)成員閱讀，你可以嘗試使用jsdoc-toolkit。如果你自動(dòng)生成的API是出自一個(gè)開放平臺(tái)，就像facebook.com應(yīng)用，那么你的文檔是給天下所有開發(fā)者看的。另外編寫完整注釋，也更方便團(tuán)隊(duì)成員閱讀你的代碼，通過你的參數(shù)描述，團(tuán)隊(duì)成員可以很容易知道你編寫的方法傳參與實(shí)現(xiàn)細(xì)節(jié)。當(dāng)然也方便日后代碼維護(hù)，這樣即使再大的項(xiàng)目，過了很長時(shí)間后，回去改點(diǎn)東西也就不至于自己都忘記了當(dāng)時(shí)自己寫的代碼是怎么一回事了。

　　4、使用規(guī)范有意義的變量名

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

　　當(dāng)然，使用有意義的變量名也盡量使用標(biāo)準(zhǔn)的命名，比如像這里：var me = this也許沒有var self = this好，因?yàn)閟elf是Python中的關(guān)鍵字，在Python中self就是通常語言this的用法。再看下面一個(gè)例子，加s顯然比沒有加來的科學(xué)些，這樣可以知道這個(gè)變量名存的是復(fù)數(shù)，可能是數(shù)組等：

var li = document.getElementsByTagName('li')var lis = document.getElementsByTagName('li') 

it知識庫：JavaScript 開發(fā)規(guī)范要求，轉(zhuǎn)載需保留來源！

鄭重聲明：本文版權(quán)歸原作者所有，轉(zhuǎn)載文章僅為傳播更多信息之目的，如作者信息標(biāo)記有誤，請第一時(shí)間聯(lián)系我們修改或刪除，多謝。