對於熟悉 C/C++ 或 Java 的工程師來說,JavaScript 顯得靈活、簡單易懂,對代碼格式的要求也相對松散,很容易上手並運用到自己的代碼中。但也正因如此,JavaScript 的編碼規範往往被輕視,開發過程中修修補補,最終演變成後續維護人員的噩夢。軟件存在的長期價值,直接與編碼質量成正比;編碼規範能幫助我們減少編程中不必要的麻煩。而 JavaScript 代碼是直接發送給客戶端瀏覽器的,直接與用戶見面,編碼質量更應受到重視。
本文淺談 JavaScript 編程中關於編碼規範的問題,分析其中緣由,希望引起更多 Web 開發人員對編碼規範與軟件產品質量的關注。
前言
提及 C/C++ 和 Java 編碼規範,許多工程師並不生疏;但說到 JavaScript 的編碼規範,你也許會忍俊不禁:JavaScript 不是語法很靈活嗎?變量隨時聲明、語句結束符可省、字符串和數字能相加、參數多一個少一個也不報錯。沒錯,從 C/C++ 和 Java 嚴格的語法之下轉向 JavaScript,會覺得自由、輕松了許多。語法松散正是 JavaScript 的重要特征,它靈活易懂,但若編寫時不加注意,代碼的調試與維護成本便會無形中增加。
JavaScript 文件引用
JavaScript 程序應盡量放在 .js 文件中,需要調用時再在 HTML 中引入,這樣有助於結構清晰、便於維護。
作用域
通過合理組織函數與變量的作用域,可以讓變量和函數的作用域變得清晰。例如,內部函數僅在外部函數內部生效,局部變量對內部函數的作用域生效,這樣的編碼方式能有效避免命名衝突。
語句
對於簡單語句,需要強調分號的必要性,同時一行最多寫一個語句。若一個賦值語句用函數和對象來賦值而需要跨多行,切記要在語句末尾加上分號。這是因為在 JavaScript 中,所有表達式都可以當作語句,遇到換行符時會被解析為表達式的結束,此時不規範的換行與丟失的分號可能引入新的錯誤。
對於復合語句——if、for、while、do、switch、try…catch 等代碼體,以及函數定義的函數體、對象定義等,都需要放在花括號 '{}' 裡面。'{' 應在行末,標志代碼塊的開始;'}' 應在一行開頭並與 '{' 所在行的開頭對齊,標志代碼塊的結束,這樣能極大提高代碼的可讀性,讓控制邏輯清晰呈現。被包含的代碼段應再縮進 4 個空格。
即使被包含的代碼段只有一句,也應使用花括號包含。雖不用花括號代碼也不會錯,但若日後需要增加語句,就容易因括號遺漏而引起編譯或邏輯錯誤。
return 語句使用時也需慎重:如果用表達式的執行作為返回值,請把表達式和 return 放在同一行,以免換行符被誤解析為語句結束而引起返回錯誤。return 關鍵字後若沒有返回表達式,則返回 undefined;構造器的默認返回值為 this。
特殊符號
空白符:適當的空白行能大大提高代碼可讀性,讓邏輯更清晰易懂。關鍵字後若有括號,最好在關鍵字與左括號 '(' 之間留空白,如 for、if、while 等;而函數名與括號之間不宜留空白,但若是匿名函數,則必須在 function 與左括號之間留空白,否則編輯器會誤認為函數名為 function。表達式中,二元運算符(除左括號 '('、左方括號 '['、作用域點 '.')與兩個操作數之間最好留空白;一元運算符(若不是 typeof 等詞)與其操作數之間不宜留空白。逗號 ',' 後面需留空白,以顯示明確的參數間隔;分號 ';' 之後通常表明語句結束而應換行,但在 for 的條件語句中,分號之後則應留空白。
{ } 和 [ ]:如需定義空對象和空數組,與其用 new Object() 和 new Array(),不如直接用花括號 '{}' 和方括號 '[]',這種寫法讓代碼更簡單易懂。
== 和 ===:判斷「邏輯等」時,JavaScript 除了可用兩個等號 '==',還可用三個等號 '==='。兩者的差別在於,'==' 會先進行類型轉換再比較,而 '===' 不會,因此 '==' 的判斷結果可能產生偏差('!=' 與 '!==' 同理)。本文提倡盡量使用 '===' 判斷邏輯等、用 '!==' 判斷邏輯不等。例如字符串變量與數字變量相比,用 '==' 時編譯器會自動把數字轉成字符串再比較,得出「相等」的錯誤結論,而用 '===' 則能得到符合預期的結果。
+:加號 '+' 除了表示數字相加、字符串連接外,還可作一元運算符把字符串轉換為數字。若使用不當,可能與自增符 '++' 混淆而引起計算錯誤。
總結
本文就 JavaScript 代碼的排版、命名、聲明、語句及一些特殊字符的使用,談了對編程規範的建議。此外還有許多方面值得深入研究,如 with、eval 語句和 this 對象的使用等。我們在認識其普遍性的同時也要注意其特殊性,編寫代碼時多用心留意,以創造更多更優質的程序代碼。