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