DIV CSS 佈局教程網

淺談 JavaScript 程式語言的編碼規範
編輯:JavaScript基礎知識     

JavaScript 作為最流行的客戶端腳本語言,早已被眾多 Web 開發人員熟悉。隨著 Web 2.0 時代來臨與 Ajax 技術廣泛應用,愈來愈多目光聚焦於此。工作崗位上對 JavaScript 的要求,不只是深入學習與靈活運用,更在於對編碼品質的保證。

對熟悉 C/C++ 或 Java 的工程師而言,JavaScript 顯得靈活、簡單易懂,對格式要求也相對寬鬆。但也正因如此,它的編碼規範常被忽視,開發過程修修補補,最終演變成後續維護人員的惡夢。軟體的長期價值與編碼品質成正比,而 JavaScript 程式碼是直接送到客戶瀏覽器的,更應受到重視。

JavaScript 檔案引用

JavaScript 程式應盡量放在 .js 檔中,需要時在 HTML 裡以 <script src="filename.js"> 引入。若程式碼並非該 HTML 專用,應避免直接寫在 HTML 中,因為這會增加檔案大小,無益於壓縮與快取。此外,<script src> 標籤應盡量放在檔案後方,以降低 JavaScript 載入對頁面其它元件載入時間的影響。

程式碼排版

行長度:每行應小於 80 個字元,過長時應換行,下一行縮進 8 個空格,以與程式碼段 4 個空格的縮進區分,增強可讀性。

行結束:JavaScript 語句應以分號結束。若程式碼行較長需換行,應選擇在運算子與標點符號之後(最好在逗號之後)換行,而不要在變數名、字串、數字或 )、]、++、-- 等符號之後換行,以避免複製貼上引起的錯誤。

var valueB = valueA   // bad,易誤解為 valueB=valueA
  + 1;
var valueC = valueB + // good,在 + 之後換行更易理解
  valueA;

縮進:建議用 4 個空格縮進,並在同一產品中採用一致標準,不建議用 TAB 鍵,因為目前仍無統一標準定義 TAB 的空白大小(有時解析為 4、有時為 8),可能造成格式混亂。若習慣 TAB,可將編輯器的 TAB 重新設定為 4 個空格。

註解

註解很重要,但要重視「品質」而非僅「數量」。註解應及時更新,避免因複製貼上產生錯誤註解而誤導閱讀者;內容應簡單清晰,並著重說明意義。例如 //initialize valueA to be sero 這種從程式碼即可看出的註解並無意義,而因複製產生的錯誤註解(如把 20 秒寫成 timeout)反而有害。建議 // 用於行註解,/* ... */ 用於整段程式碼或較正式的宣告說明。

識別符命名

命名規則:以字母、底線 _ 或美元符號 $ 開頭;可含字母、數字、底線與美元符號;區分大小寫。變數、參數、成員變數、函數等以小寫字母開頭,建構子以大寫字母開頭。_ 開頭慣用於標識私有/局部成員,$ 開頭慣用於標識系統相關,但應避免使用這兩個符號來命名。

宣告

變數的宣告:雖然 JavaScript 不要求先宣告再使用,但仍應養成習慣,以避免變數變成隱藏的全域變數。應在函數開頭用 var 宣告局部變數並排序、每個變數單獨一行以便註解。因為 JavaScript 中只有函數的 {} 界定作用域,用 var 宣告的才是局部變數,否則會被視為全域變數。

var valueA = "a";
var valueB = "b";
function f1() {
  var valueA = "c";   // 局部變數
  valueB = "d";       // 未宣告,成為全域變數
}
f1();
alert(valueA); // a
alert(valueB); // d,被改變了

函數的宣告:應在呼叫前宣告,內部函數應在 var 宣告之後,以清楚標示作用域。函數名與左括號 ( 之間不留空白,右括號 ) 與 { 之間要留空格;匿名函數則要在 function 與 ( 之間留空白,否則易誤認為函數名為 function。

語句

一行最多一個語句;若賦值語句跨多行,切記在結尾加分號。複合語句(if、for、while、do、switch、try...catch 等)與函數、物件定義都應放在花括號中:{ 在行末、} 在一行開頭並與 { 對齊,內部程式碼再縮進 4 個空格;即使只有一句話也應加上花括號,方便日後擴充。

return 語句若帶表達式,請與 return 放在同一行,以免換行被誤解析為語句結束而導致錯誤:

function F1() {
  return valueA + valueB;  // 正確回傳 3
}
function F2() {
  return                   // 換行後被視為語句結束
  valueA + valueB;         // 實際上回傳 undefined
}

特殊符號

== 與 ===:== 比較時會先做型別轉換再比較,=== 則不會。因此建議盡量使用 === 進行相等判斷、!==' 進行不等判斷,以避免型別自動轉換造成的偏差。

var valueA = "1", valueB = 1;
if (valueA == valueB)  { /* 相等:會自動轉型 */ }
if (valueA === valueB) { /* 不相等:型別不同 */ }

+ 號:JavaScript 中的 + 除了數字相加、字串串接,還可作一元運算子把字串轉為數字,使用不當易與遞增符 ++ 混淆:

var valueA = 20, valueB = "10";
alert(valueA + valueB);      // 2010(字串串接)
alert(valueA + (+valueB));   // 30(一元 + 轉數字)
alert(valueA + +valueB);     // 30
alert(valueA ++valueB);      // 編譯錯誤

總結

本文就 JavaScript 的排版、命名、宣告、語句與特殊符號使用等方面提出了編碼規範建議。此外還有許多值得深入研究的主題,如 with、eval 語句與 this 物件的使用等。在編寫程式碼時多用心留意這些細節,才能創造更多、更優質的程式碼。

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