DIV CSS 佈局教程網

JavaScript 編碼規範指南:排版、命名、聲明與特殊符號
編輯:JavaScript綜合知識     

對熟悉 C/C++ 或 Java 的工程師而言,JavaScript 顯得靈活隨意:變數隨用隨宣告、分號可省、字串數字相加也不報錯。正因為門檻低,編碼規範常被忽略,最後變成維護者的惡夢。軟體的長期價值與程式碼品質成正比,而 JavaScript 又會直接送到使用者瀏覽器執行,更應該受到重視。

檔案引用

JavaScript 應盡量放在獨立 .js 檔中,以 <script src="filename.js"> 引入。非該 HTML 專用的程式碼尤其不該內嵌,否則會增加檔案體積、無法壓縮與快取。此外,script 標籤應放在文件後段(body 結束前),讓頁面其他內容先完成載入。

代碼排版

行長度

每行應小於 80 字元。過長時換行並縮進 8 個空格,這樣能與一般程式碼段的 4 空格縮進區分開,一眼看出是續行。

行結束

語句應以分號結束。大多數瀏覽器允許省略,但換行時若位置不當就會出錯。換行應選在運算子與標點之後,最好在逗號之後;不要在變數名、字串、數字或 ) ] ++ -- 之後換行。

比較一下這兩種寫法:

var valueB
    = valueA + valueC;   // 換行在變數名後,易誤讀為 valueB = valueA

var valueB =
    valueA + valueC;     // 換行在等號後,語意清楚

縮進

建議統一用 4 個空格縮進,同一個產品內採用相同標準。不建議用 TAB,因為至今沒有統一標準定義 TAB 的寬度——某些編輯器視為 4 格、某些視為 8 格,換編輯器看就可能格式大亂。若實在想用 TAB 的便利,請在編輯器設定中把 TAB 對應為 4 個空格(Eclipse、Vim、Notepad++、EditPlus、UltraEdit 等都支援此設定)。

注釋

大家常強調「注釋數量」,卻忽略了注釋品質。不及時更新的注釋、或複製貼上造成的錯誤注釋,反而會誤導讀者。

var valueA = 0;    // initialize valueA to be zero —— 毫無意義
setTimeout(fn, 3000);  // set timeout to be 20s —— 數字與描述不符,且描述錯誤

setTimeout 的作用並非「設定超時時間」,而是「等待一段時間後執行函式」,這種錯誤注釋害人不淺。注釋應簡單明瞭,著重說明「為什麼」而非「做了什麼」,對不直觀的部分才需要註解。另外建議 // 用於單行說明,/* ... */ 用於整段區塊或函式參數、功能、檔案用途等正式描述。

標識符命名

JavaScript 標識符規則:以字母、底線 _ 或 $ 開頭,可含字母數字與這兩個符號,且區分大小寫。

  • 變數、參數、成員、函式名以小寫字母開頭;建構函式名以大寫字母開頭
  • 底線開頭慣例上表示私有/區域成員
  • $ 開頭慣例上表示系統相關(如 jQuery 物件)
  • 應避免用底線或 $ 命名,以降低閱讀負擔

聲明

變數

即使語言不要求,也應養成「使用前先宣告」的習慣,這樣容易發現未宣告的變數,避免它變成隱藏的全域變數。

應在函式開頭用 var 一次宣告所有區域變數,並按字母順序排列、各自佔一行以便加註釋。原因在於 JavaScript 只有函式的 {} 構成作用域(let/const 的區塊作用域是 ES6 之後的事),漏寫 var 的變數會成為全域:

valueA = 1;          // 未宣告 → 全域變數
var valueB = 2;      // 區域變數

函式

函式也應在呼叫前宣告,內部函式放在 var 宣告之後,以清楚呈現作用域。函式名與左括號之間不留空格,右括號與 { 之間留一個空格;若是匿名函式,function 與左括號之間必須留空格,否則會被誤認為函式名叫 function。

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

語句

簡單語句一行最多一個,賦值語句若跨多行,務必在結尾加上分號。這是因為 JavaScript 中所有運算式都可視為語句,遇換行會被解析為結束,不規範的換行加上遺漏分號可能引入新錯誤。

複合語句(if、for、while、do、switch、try…catch)、函式主體、物件定義都必須用大括號包起來。{ 放在行末,} 放在行首並與對應的 { 開頭對齊,內部程式碼再縮進 4 格。即使只有一行也應加大括號,否則日後新增語句時容易因遺漏而產生邏輯錯誤。

return 語句尤需謹慎,運算式要與 return 放在同一行:

return                 // 換行後被解析為語句結束,實際回傳 undefined
  valueA + valueB;

return valueA + valueB;  // 正確寫法

return 後若無運算式則回傳 undefined;建構函式的預設回傳值為 this。

特殊符號

空白

適當的空白行與運算式中的空格能大幅提升可讀性。關鍵字(for、if、while 等)與左括號之間留空格;函式名與括號之間不留;匿名函式則必須在 function 與括號間留空格。二元運算子與兩個運算元之間留空格,一元運算子則不留。逗號後留空格,分號後則換行(for 條件式中的分號後留空格)。

{ } 與 [ ]

定義空物件與空陣列時,{} 與 [] 比 new Object()、new Array() 更簡潔明瞭。

== 與 ===

== 比較前會先做型別轉換,=== 不會,因此前者容易產生意料之外的結果:

var valueA = "1";
var valueB = 1;

valueA == valueB;    // true —— valueB 被轉為字串後比較
valueA === valueB;   // false —— 型別不同,直接不相等

建議一律用 === 判等、!== 判不等。!= 與 !== 的差異同理。

+ 號

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

var valueA = 20;
var valueB = "10";

valueA + valueB;          // "2010" —— 字串串接
valueA + (+valueB);       // 30 —— 一元加號先轉型
valueA + +valueB;         // 30
valueA ++valueB;          // 編譯錯誤,被解析為遞增運算子

結語

以上就排版、命名、聲明、語句與特殊符號談了 JavaScript 編碼規範的建議。此外還有 with、eval 的使用與 this 的綁定等議題值得深入。在理解共通原則的同時也要留意語言的特殊性,寫程式時多留心,才能產出更優質的程式碼。

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