1.嵌入規(guī)則 Javascript程序應(yīng)該盡量放在.js的文件中,需要調(diào)用的時(shí)候在頁面中以<script src="filename.js">的形式包含進(jìn)來。Javascript代碼若不是該頁面專用的,則應(yīng)盡量避免在頁面中直接編寫Javascript代碼。 2.對齊縮進(jìn)與換行 a) 縮進(jìn) 在同一系統(tǒng)中應(yīng)采用同一種縮進(jìn)標(biāo)準(zhǔn),本文提倡縮進(jìn)大小為4個(gè)空格。各編譯器對Tab鍵所代替的空白大小定義不同。建議在設(shè)置開發(fā)環(huán)境時(shí),將編輯器里的Tab快捷鍵重新設(shè)置成4個(gè)空格。多數(shù)編譯器提供了此功能。否則建議按4次空格來進(jìn)行縮進(jìn)。 b) 換行 在以下位置必須換行: 每個(gè)獨(dú)立語句結(jié)束后; if、else、catch、finally、while等關(guān)鍵字前; 運(yùn)算符處換行時(shí),運(yùn)算符必須在新行的行首。 對于因?yàn)閱涡虚L度超過限制時(shí)產(chǎn)生的換行,參考行長度中的策略進(jìn)行分隔。 1).字符串過長截?cái)?/strong> 每行代碼應(yīng)小于80個(gè)字符。若代碼較長應(yīng)盡量換行,換行應(yīng)選擇在操作符和標(biāo)點(diǎn)符號之后,最好是在分號“;”或逗號“,”之后。下一行代碼相對上一行縮進(jìn)4個(gè)空格。這樣可以有效防止復(fù)制粘貼引起的代碼缺失等錯(cuò)誤并增強(qiáng)可讀性。 按一定長度截?cái)嘧址?,并使?運(yùn)算符進(jìn)行連接。分隔字符串盡量按語義進(jìn)行,如不要在一個(gè)完整的名詞中間斷開。特別的,對于HTML片段的拼接,通過縮進(jìn),保持和HTML相同的結(jié)構(gòu): 也可使用數(shù)組來進(jìn)行拼接,相對+運(yùn)算更容易調(diào)整縮進(jìn): 2).三元運(yùn)算符過長 三元運(yùn)算符由3部分組成,因此其換行應(yīng)當(dāng)根據(jù)每個(gè)部分的長度不同,形成3種不同的情況: 不得出現(xiàn)以下情況: 3).過長的邏輯條件組合 當(dāng)因?yàn)檩^復(fù)雜的邏輯條件組合導(dǎo)致80個(gè)字符無法滿足需求時(shí),應(yīng)當(dāng)將每個(gè)條件獨(dú)立一行,邏輯運(yùn)算符放置在行首進(jìn)行分隔,或?qū)⒉糠诌壿嫲催壿嫿M合進(jìn)行分隔。最終將右括號)與左大括號{放在獨(dú)立一行,保證與if內(nèi)語句塊能容易視覺辨識。如: 4).過長的JSON和數(shù)組 如果對象屬性較多導(dǎo)致每個(gè)屬性一行占用空間過大,可以按語義或邏輯進(jìn)行分組的組織,如: 通過5個(gè)一組的分組,將每一行控制在合理的范圍內(nèi),并且按邏輯進(jìn)行了切分。 對于項(xiàng)目較多的數(shù)組,也可以采用相同的方法,如: 5).return語句 return如果用表達(dá)式的執(zhí)行作為返回值,請把表達(dá)式和 return 放在同一行中,以免換行符被誤解析為語句的結(jié)束而引起返回錯(cuò)誤。return 關(guān)鍵字后若沒有返回表達(dá)式,則返回 undefined。構(gòu)造器的默認(rèn)返回值為 this。 示例: 3.命名 命名的方法通常有以下幾類: a).命名法說明 1).camel命名法,形如thisIsAnApple 2).pascal命名法,形如ThisIsAnApple 3).下劃線命名法,形如this_is_an_apple · 4).中劃線命名法,形如this-is-an-apple 根據(jù)不同類型的內(nèi)容,必須嚴(yán)格采用如下的命名法: b).變量名:必須使用camel命名法 c).參數(shù)名:必須使用camel命名法 d).函數(shù)名:必須使用camel命名法 e).方法/屬性:必須使用camel命名法 f).私有(保護(hù))成員:必須以下劃線_開頭 g).常量名:必須使用全部大寫的下劃線命名法,如IS_DEBUG_ENABLED h).類名:必須使用pascal命名法 i).枚舉名:必須使用pascal命名法 j).枚舉的屬性:必須使用全部大寫的下劃線命名法 k).命名空間:必須使用camel命名法 l).語義:命名同時(shí)還需要關(guān)注語義,如: 變量名應(yīng)當(dāng)使用名詞; boolean類型的應(yīng)當(dāng)使用is、has等起頭,表示其類型;· 函數(shù)名應(yīng)當(dāng)用動(dòng)賓短語; 類名應(yīng)當(dāng)用名詞。 4.注釋 注釋要盡量簡單,清晰明了。著重注釋的意思,對不太直觀的部分進(jìn)行注解: (當(dāng)然這種直接定義一堆全局變量的做法不推薦) 此外,JavaScript 的注釋有兩種"http://" 和"/* .... */",建議"http://"用作代碼行注釋,"/* .... */"形式用作對整個(gè)代碼段的注銷,或較正式的聲明中,如函數(shù)參數(shù)、功能、文件功能等的描述中: 另:復(fù)制粘貼應(yīng)注意注釋是否與代碼對應(yīng)。 5.聲明 1).變量的聲明 盡管 JavaScript 語言并不要求在變量使用前先對變量進(jìn)行聲明。但我們還是應(yīng)該養(yǎng)成這個(gè)好習(xí)慣。這樣可以比較容易的檢測出那些未經(jīng)聲明的變量,避免其變?yōu)殡[藏的全局變量,造成隱患。 在函數(shù)的開始應(yīng)先用 var 關(guān)鍵字聲明函數(shù)中要使用的局部變量,注釋變量的功能及代表的含義,且應(yīng)以字母順序排序。每個(gè)變量單獨(dú)占一行,以便添加注釋。這是因?yàn)?JavaScript 中只有函數(shù)的 {} 表明作用域,用 var 關(guān)鍵字聲明的局部變量只在函數(shù)內(nèi)有效,而未經(jīng) var 聲明的變量則被視為全局變量。示例: 用 var 聲明過的變量 valueA 和沒有聲明的變量 valueB 是有區(qū)別的。特別需要注意的是,在函數(shù)內(nèi)部用 var 聲明的變量為局部變量,這樣可以有效地避免因局部變量和全局變量同名而產(chǎn)生的錯(cuò)誤。 2).函數(shù)的聲明 函數(shù)也應(yīng)在調(diào)用前進(jìn)行聲明,內(nèi)部函數(shù)應(yīng)在 var 聲明內(nèi)部變量的語句之后聲明,可以清晰地表明內(nèi)部變量和內(nèi)部函數(shù)的作用域。 此外,函數(shù)名緊接左括號'('之間,而右括號')'和后面的'{'之間要有個(gè)空格,以清楚地顯示函數(shù)名以其參數(shù)部分,和函數(shù)體的開始。若函數(shù)為匿名 / 無名函數(shù),則 function 關(guān)鍵字和左括號'('之間要留空格,否則可能誤認(rèn)為該函數(shù)的函數(shù)名為 function。 內(nèi)部函數(shù)聲明示例:
從上例的輸出可以看出,inF() 函數(shù)僅在 outF() 函數(shù)的內(nèi)部生效,局部變量 innerA 對內(nèi)部函數(shù)的作用域生效。這樣的編碼方式使得變量和函數(shù)的作用域變得清晰。 |
|