發(fā)布時(shí)間:2015/05/03 來(lái)源:長(zhǎng)沙做網(wǎng)站
對(duì)于一個(gè)組織而言,代碼庫(kù)的質(zhì)量和軟件的長(zhǎng)期價(jià)值成正比。在它的生命周期內(nèi),一個(gè)程序會(huì)經(jīng)手很多人。如果一個(gè)程序可以清晰的傳達(dá)它的結(jié)構(gòu)和和特點(diǎn),在不遠(yuǎn)的將來(lái)修改時(shí)就不太可能會(huì)崩潰。編碼約定有助于減少代碼的脆性。所有JavaScript代碼都是公開(kāi)發(fā)送的。它也應(yīng)該總是出版物的質(zhì)量。整齊很重要。我們?cè)谧鼍W(wǎng)站的時(shí)候需要經(jīng)常的使用javascript,就需要有JavaScript編程中的一系列代碼約定和規(guī)則。
JavaScript程序應(yīng)該以.js
文件保存和傳輸。 JavaScript不應(yīng)該嵌入在HTML文件中,除非代碼是針對(duì)一個(gè)特定的session。將JS代碼嵌入在HTML中,會(huì)導(dǎo)致由于不能通過(guò)緩存和壓縮來(lái)減小頁(yè)面體積而使其顯著增加。
<script src=filename.js
標(biāo)簽在<body></body>
標(biāo)簽中出現(xiàn)的越晚越好。這減小了其他頁(yè)面組件的的腳本加載而帶來(lái)的影響。沒(méi)有必要用language
或type
屬性。決定MIME類型是服務(wù)器而不是腳本標(biāo)簽的職責(zé)。
縮進(jìn)的單位是4個(gè)空格。應(yīng)該避免使用制表符,因?yàn)椋ㄔ?1世紀(jì)的今天)仍然沒(méi)有取代制表符的標(biāo)準(zhǔn)。使用空格會(huì)產(chǎn)生更大的文件體積,但在內(nèi)網(wǎng)這個(gè)增長(zhǎng)不會(huì)很明顯,而且這個(gè)差異會(huì)被minification縮小。
避免長(zhǎng)于80個(gè)字符的行。當(dāng)一個(gè)語(yǔ)句在一行不合適時(shí),可能需要斷行。把斷行放在操作符之后,理想情況下放在逗號(hào)后面。操作符后面的換行會(huì)減少因?yàn)椴迦敕痔?hào)而掩蓋的復(fù)制粘貼錯(cuò)誤的可能性。下一行應(yīng)該縮進(jìn)8個(gè)空格。
寫(xiě)注釋時(shí)慷慨一些吧。留一些信息給將來(lái)可能會(huì)讀到的人(可能是你自己),他可能會(huì)需要理解你做的事情。注釋需要寫(xiě)好并寫(xiě)清晰,就像它們要標(biāo)注的代碼一樣。偶爾一個(gè)幽默的金塊兒可能會(huì)得到感恩,但挫折和怨恨可不能。
保持注釋的更新很重要。有錯(cuò)誤的注釋會(huì)讓代碼更難閱讀和理解。
只做有意義的注釋。專注于那些不能被立即看到的。不要浪費(fèi)閱讀者的時(shí)間去看這些東西:
1
|
|
通常用行注釋。留著塊注釋做正式的文檔。
所有的變量都應(yīng)該在使用前聲明。JavaScript不要求如此,但這樣做可以讓代碼更易讀并且容易檢測(cè)到那些沒(méi)有聲明的隱式的全局變量。隱式的全局變量永遠(yuǎn)都不要用。全局變量的使用要盡量減少。
在函數(shù)題中,var
語(yǔ)句應(yīng)該是第一條語(yǔ)句。
最好給每個(gè)變量單獨(dú)的行和注釋。如果可能的話,盡量用字母順序給它們排序。
1 2 3 |
|
JavaScript沒(méi)有塊作用域,所以在代碼塊中定義變量可能會(huì)讓經(jīng)驗(yàn)豐富的C系程序員很困惑。在函數(shù)開(kāi)頭定義所有的變量。
所有的函數(shù)都應(yīng)該顯定義再使用。內(nèi)部函數(shù)應(yīng)該位于var
語(yǔ)句之后。這樣可以更容易的看出在這個(gè)作用域內(nèi)包含的變量。
函數(shù)名和參數(shù)列表左括號(hào)之間不應(yīng)該有空格。右括號(hào)和大括號(hào)之間應(yīng)該有一個(gè)空格。函數(shù)體應(yīng)該縮進(jìn)4個(gè)空格。