DIV CSS 佈局教程網

JavaScript 程式碼編寫格式規範指南
編輯:JavaScript基礎知識     

對於熟悉 C/C++ 或 Java 的工程師而言,JavaScript 顯得格外靈活、簡單易懂,對程式碼格式的要求也相對寬鬆,因而容易上手並融入自己的專案。但也正因如此,JavaScript 的編碼規範常常被忽視:開發過程中東修西補,最終演變成後續維護人員的噩夢。

軟體的長期價值,往往與編碼品質成正比。良好的編碼規範能幫助我們減少大量不必要的困擾。而 JavaScript 程式碼是直接發送給使用者瀏覽器、直接與使用者見面的,其編碼品質更應受到重視。

本文將就 JavaScript 編程中涉及排版、命名、宣告、作用域及特殊符號使用等方面的規範問題展開探討,並分析背後的原因,希望能引起更多 Web 開發者對 JavaScript 編碼規範與軟體產品品質的重視。

前言

提到 C/C++ 與 Java 的編碼規範,許多工程師並不陌生;但說到 JavaScript 的編碼規範,或許有人會忍俊不禁:JavaScript 的語法不是很靈活嗎?變數隨用隨宣告、語句結束符可省、字串與數字能相加、參數多一個少一個也不報錯。沒錯,從 C/C++ 與 Java 嚴格的語法約束轉向 JavaScript,確實會感到自由許多。語法寬鬆正是 JavaScript 的重要特徵,它靈活易懂,為開發帶來便利,但若在編寫過程中不加留意,程式碼的除錯成本與維護成本便會悄然攀升。

JavaScript 程式碼會被直接發送到使用者端瀏覽器執行,因此程式碼規範不僅是品質的保證,也關係到產品的長期信譽。希望這一話題同樣能引起更多朋友的關注。

JavaScript 編碼規範建議

本文就 JavaScript 編碼過程中的排版、命名、宣告、作用域及特殊符號使用等方面,結合筆者學習與工作中的總結給出一些建議並分析緣由,以供參考。

JavaScript 檔案引用

JavaScript 程式應盡量放在 .js 檔案中,需要時再以 <script src="filename.js"> 的形式引入。若某段 JavaScript 並非該 HTML 檔案專用,則應盡量避免直接在 HTML 中編寫,因為這樣會大幅增加 HTML 檔案體積,不利於程式碼壓縮與快取。

此外,<script src="filename.js"> 標籤應盡量放在檔案末尾,以降低 JavaScript 載入對頁面其他元件載入時間的影響。

程式碼排版

行長度
每行程式碼應少於 80 個字元。若程式碼較長,應盡量換行,下一行縮進 8 個空格。這樣既能讓排版整齊、減輕閱讀疲勞,又能透過 8 個空格的換行縮進與 4 個空格的程式碼段縮進相區分,增強可讀性。

行結束
JavaScript 語句應以分號結束。雖然大多數瀏覽器允許省略分號(只要在本應是分號處有換行符即可),但當程式碼較長需要換行時,仍需注意:換行應選在運算子與標點符號之後,最好在逗號 ',' 之後,而不要在變數名、字串、數字或 ')'、']'、'++'、'--' 等符號之後換行。這樣能有效防止複製、粘貼引起的錯誤,並增強可讀性。請看下面的例子:

 var valueA = 1; var valueB = valueA ///bad +1; var valueC = valueB + ///good valueA; alert(valueB); //output: valueB=2 alert(valueC);//output: valueC=3 

輸出結果符合我們的期望,但就寫法而言,對 valueB 的賦值是在變數 valueA 之後換行,容易被誤解為 valueB = valueA,給閱讀造成障礙;而對 valueC 的賦值是在 '+' 之後換行,就清晰易懂得多——這正是本文所提倡的換行方式。

縮進
縮進問題幾乎是所有語言編碼規範的第一課,也是判斷可讀性的直接因素。縮進的好處不言自明,但如何縮進卻沒有標準答案:有人偏好 TAB 鍵,有人喜歡 2、4 或 8 個空格,風格不一同樣會給閱讀帶來障礙。

本文提倡用 4 個空格縮進,並在同一產品中採用統一的縮進標準,不建議使用 TAB 鍵。這是因為至今沒有統一的標準來定義 TAB 鍵所代表的空白寬度——有的編輯器解析為 4 個空格,有的解析為 8 個,用不同編輯器查看時可能造成格式混亂。當然 TAB 簡單易用,為解決這一問題,建議在設定開發環境時,將編輯器中的 TAB 鍵重新設定為 4 個空格。據了解,Eclipse、Vi、Notepad++、EditPlus、UltraEdit 等主流編輯器都提供了此功能。

註釋
程式碼中的註釋十分重要。我們通常強調註釋的數量,卻容易忽視註釋的品質。及時添加註釋能給後續維護帶來便利,但若註釋不及時更新,或因複製、粘貼而出現錯誤,反而會誤導閱讀者。因此,除了及時更新,我們還應特別關注註釋內容:註釋要盡量簡單、清晰,避免含混晦澀的語言,並著重於「意義」,對不夠直觀的部分加以說明。請看下面的例子:

 //following section is used to initialize golbal variables (good) var valueA = 0; //initialize valueA to be sero (bad) var valueB = 1; ... //call f1 function after waiting for 50 seconds. (good) setTimeout(f1,50000); //set timeout to be 20s (copy error) ... 

「initialize valueA to be sero」這樣的註釋有何意義?難道工程師從「var valueA = 0;」還看不出來嗎?而「set timeout to be 20s」這條註釋,不僅因複製粘貼而寫錯了時間,更誤導了對該語句的理解——setTimeout() 的作用並非設定函數執行的超時時間,而是等待一段時間後執行所呼叫的函數。這樣的註釋寧可刪掉。此外,JavaScript 有兩種註釋:「//」建議用於程式碼行註釋,「/* ... */」則用於整個程式碼段或較正式的宣告(如函數參數、功能、檔案功能描述)。

標識符命名
JavaScript 標識符的命名規則:以字母、下劃線 '_' 或美元符號 '$' 開頭;名稱中可包含字母、數字、下劃線 '_' 與美元符號 '$';且區分大小寫。

變數、參數、成員變數、函數等名稱均以小寫字母開頭,建構子名稱則以大寫字母開頭。下劃線 '_' 開頭的變數通常用於標識私有/局部成員,美元符號 '$' 開頭則用於標識系統相關內容。應盡量避免用 '_' 或 '$' 命名標識符,以盡可能降低閱讀負擔。

宣告

變數的宣告
儘管 JavaScript 並不要求變數使用前先宣告,但我們仍應養成這一好習慣,這樣更容易檢查出未經宣告的變數,避免它們變成隱藏的全域變數而埋下隱患。

應在函數開頭先用 var 關鍵字宣告函數中要使用的區域變數,註釋其功能與含義,並以字母順序排序,每個變數單獨佔一行以便添加註釋。這是因為 JavaScript 中只有函數的 {} 才構成作用域:用 var 宣告的區域變數僅在函數內有效,而未經 var 宣告的變數則被視為全域變數。請看下例:

 var valueA = "a"; var valueB = "b"; function f1() { var valueA = "c"; alert("valueA="+valueA); //output: valueA=c valueB = "d"; alert("valueB="+valueB); //output: valueB=d } f1(); alert("valueA="+valueA); //output: valueA=a alert("valueB="+valueB); //output: valueB=d 

從輸出中不難發現,用 var 宣告的變數 valueA 與未宣告的變數 valueB 存在明顯區別。特別需要注意的是,函數內部用 var 宣告的變數為區域變數,這能有效避免區域變數與全域變數同名所引發的錯誤。

函數的宣告
函數也應在呼叫前宣告,內部函數應在 var 宣告內部變數的語句之後宣告,以清晰表明內部變數與內部函數的作用域。此外,函數名應緊接左括號 '(',而右括號 ')' 與後面的 '{' 之間要留一個空格,以清楚顯示函數名、參數部分與函數體的起點。若為匿名函數,則 function 關鍵字與左括號 '(' 之間要留空格,否則可能被誤認為函數名是 function。

 var innerA = 1; function outF() { var innerA = 2; function _inF() { alert("valueA="+innerA); } _inF(); } outF(); //output: valueA=2 _inF(); //error: innerF is not defined 

從上例可見,inF() 函數僅在 outF() 內部生效,區域變數 innerA 對內部函數的作用域生效。這樣的編碼方式讓變數與函數的作用域變得清晰。

語句
對於簡單語句,仍需強調分號的必要性,同時一行最多一個語句。若賦值語句以函數或物件賦值、需要跨多行,切記要在語句末尾加上分號——因為在 JavaScript 中,所有表達式都可當作語句,遇到換行符會被解析為表達式的結束,此時不規範的換行與分號遺失都可能引入新錯誤。

對於複合語句,如 if、for、while、do、switch、try...catch 等程式碼體,函數定義的函數體,以及物件定義等,都需放在花括號 '{}' 內。'{' 應在行末,標誌程式碼塊的開始;'}' 應在一行開頭,並與 '{' 所在行的開頭對齊,以表明一個完整的複合語句段。被包含的程式碼段應再縮進 4 個空格。即使被包含的程式碼段只有一句,也應用花括號包起來——雖然不寫也不會出錯,但日後若需增加語句,容易因遺漏花括號而導致編譯錯誤或邏輯錯誤。

return 語句使用時也需慎重:若以表達式的執行結果作為回傳值,請把表達式與 return 放在同一行,以免換行符被誤解析為語句結束而導致回傳錯誤。return 關鍵字後若沒有回傳表達式,則回傳 undefined;建構子的預設回傳值為 this。

 function F1() { var valueA = 1; var valueB = 2; return valueA + valueB; } function F2() { var valueA = 1; var valueB = 2; return valueA + valueB; } alert( F1() ); //output: 3 alert( F2() ); //ouput: undefined 

上例展示了因回傳表達式未與 return 放在同一行而引起的回傳錯誤,需引起重視。

特殊符號

空白符
適當的空白行能大幅提升可讀性,讓程式碼邏輯更清晰。在表達式中適當留白也有助於閱讀:關鍵字後若有括號(如 for、if、while),最好在關鍵字與左括號 '(' 之間留空白;而函數名與括號之間則不宜留空白,但若是匿名函數,則必須在 function 與左括號 '(' 之間留空白,否則編輯器會誤認為函數名為 function。

在表達式中,二元運算子(除左括號 '('、左方括號 '['、作用域點 '.' 外)與兩個運算元之間最好留空白;一元運算子(若非 typeof 等詞)與其運算元之間則不宜留空白。逗號 ',' 之後需留空白,以顯示明確的參數間隔與變數間隔。分號 ';' 之後通常表示表達語句結束,應換行;而在 for 的條件語句中,分號之後則應留空白。

{ } 和 [ ]
在 JavaScript 中,如需定義空物件與空陣列,通常會直覺地想到 new Object() 與 new Array()。其實花括號 '{}' 與方括號 '[]' 可直接用來定義空物件與空陣列,這種寫法更簡單易懂。

== 和 ===
判斷「邏輯等」在程式碼中再平常不過,但 JavaScript 與其他語言不同:除了可用兩個等號 '==' 判斷外,還可用三個等號 '==='。二者的區別在於,'==' 作判斷時會先進行型別轉換再比較,而 '===' 則不會,因此 '==' 的判斷結果可能產生偏差;'!=' 與 '!==' 的區別亦是如此。本文提倡盡量使用 '===' 作邏輯等判斷、用 '!==' 作邏輯不等判斷。

 var valueA = "1"; var valueB = 1; if ( valueA == valueB) { alert("Equal"); } else { alert("Not equal") } //output: "Equal" if ( valueA === valueB) { alert("Equal"); } else { alert("Not equal") } //output: "Not equal" 

上例中,valueA 是字串、valueB 是數字,兩者顯然不相等,但用 '==' 判斷卻輸出了「Equal」——因為編譯器在比較時會自動把 valueB 轉換為字串再與 valueA 比較。而用 '===' 得到的結果則完全符合預期。

+
加號 '+' 也是工程師熟知的操作符。JavaScript 與其他語言不同的是,'+' 除了表示數字相加、字串相連外,還可作為一元運算子把字串轉換為數字。因此若使用不當,可能與自增符 '++' 混淆而導致計算錯誤,這一點從下例可清楚看出。

 var valueA = 20; var valueB = "10"; alert( valueA + valueB); //ouput: 2010 alert( valueA + (+valueB)); //output: 30 alert( valueA + +valueB); //output:30 alert( valueA ++valueB); //Compile error 

總結
本文就 JavaScript 程式碼的排版、命名、宣告、語句及特殊字元使用等方面,談了筆者對編程規範的一些建議。此外,還有許多方面值得深入研究,如 with、eval 語句與 this 物件的使用等。我們在認識其普遍性的同時,也需注意其特殊性,在編寫程式碼時多用心留意,方能創造出更多、更優質的程式碼。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved