DIV CSS 佈局教程網

JavaScript 編碼規範指南:排版、命名、宣告與特殊符號的正確用法
編輯:JavaScript綜合知識     

對熟悉 C/C++ 或 Java 的工程師來說,JavaScript 顯得靈活、簡單,對程式碼格式的要求也相對寬鬆。正因如此,它的編碼規範往往被輕視:開發過程中修修補補,最終成了後接手者的一場噩夢。

軟體的長期價值與程式碼品質成正比。而 JavaScript 有一個別的語言沒有的特性——它會被直接送到使用者的瀏覽器執行,直接與客戶見面。這讓編碼品質的重要性又更高一層。

前言:寬鬆是特色,也是陷阱

從 C/C++ 或 Java 那種嚴格語法轉過來,會覺得 JavaScript 自由得多:變數隨用隨宣告、語句結尾的分號可省、字串和數字還能相加、參數多一個少一個也不報錯。這些都是事實,也是它易學好用的原因。

但語法寬鬆不代表可以不講規範。開發時一點一點累積的隨手寫法,會讓後續的除錯與維護成本無形中倍增。本文就 JavaScript 編碼中涉及的排版、命名、宣告、作用域與特殊符號使用,整理一些建議與背後的理由。

檔案引用

JavaScript 程式應盡量放在獨立 .js 檔中,需要時再以 script 標籤引入,而不是把大量程式碼內嵌在 HTML 裡。這麼做除了便於維護,也能讓瀏覽器快取檔案,減少重複下載。

縮進

縮進幾乎是所有語言編碼規範的第一課,也是程式碼可讀性最直接的判斷依據。好處不必多說,問題在於「縮進幾格」始終沒有標準答案。

有人用 TAB,有人用 2、4、8 個空格。風格不一,同樣會給閱讀帶來障礙。本文建議統一用 4 個空格,並在同一個產品中維持一致。

不建議用 TAB 的原因很實際:至今沒有統一標準定義一個 TAB 相當於幾個空格,有的編輯器解析為 4 格、有的為 8 格,換個編輯器開啟就可能格式大亂。如果實在習慣 TAB 的順手,做法是把它重新映射為 4 個空格——Eclipse、Vim、Notepad++、EditPlus、UltraEdit 等主流編輯器都提供這個設定。

註解

註解的重要性毋庸置疑,但我們往往只強調「數量」,忽略了「品質」。及時加上註解確實能大幅降低維護成本;但過時的註解、或因為複製貼上而寫錯的註解,反而會誤導閱讀者,比沒有註解更糟。

清單 2. 有意義的註解

<script language="javascript">
//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)
...
</script>

像 //initialize valueA to be sero 這樣的註解毫無價值——看 var valueA = 0; 誰都懂,而且還把 zero 拼錯了。//set timeout to be 20s 更糟,除了複製貼上造成的數字錯誤,它連語意都錯了:setTimeout() 並非設定逾時時間,而是「等待一段時間後執行函式」。這種註解寧可刪掉。

此外,JavaScript 有 // 與 /* ... */ 兩種註解。建議 // 用於單行說明,/* ... */ 用於整段程式碼的註記,或函式參數、功能、檔案用途等較正式的宣告描述。

標識符命名

JavaScript 的命名規則:可用字母、底線 _ 或美元符號 $ 開頭;名稱中可含字母、數字、底線與美元符號;區分大小寫。

慣例上,變數、參數、成員、函式名稱以小寫字母開頭,建構函式名稱則大寫開頭。底線開頭通常用來標示私有或區域成員,美元符號開頭則慣例上保留給系統相關用途(如 jQuery)。日常程式碼應避免用這兩個符號命名,以降低閱讀負擔。

變數宣告

JavaScript 不要求使用前先宣告變數,但我們仍應養成這個習慣。這樣才能容易揪出未經宣告的變數,避免它們悄悄變成隱藏的全域變數。

應在函式開頭用 var 一次宣告所有區域變數,並為每個變數加上說明、依字母排序、各自獨立一行以便加註解。原因在於 JavaScript 中只有函式的大括號构成作用域:用 var 宣告的區域變數僅在函式內有效,未經 var 宣告者則一律視為全域變數。

清單 3. 區域變數宣告

<script language="javascript">
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
</script>

從輸出可以看到,用 var 宣告的 valueA 與未宣告的 valueB 行為截然不同:函式內對 valueA 的修改不會外溢,而 valueB 卻改動了全域的值。這正是為什麼函式內部的變數一定要用 var(或 let/const)宣告——它能有效避免區域變數與全域變數同名而引發的錯誤。

函式宣告

函式同樣應在呼叫前宣告,內部函式則應放在 var 宣告之後,以清楚呈現作用域關係。

格式上,函式名緊接左括號,右括號與後方的 { 之間留一個空格,能清楚區隔函式名、參數列與函式主體。若是匿名函式,function 關鍵字與左括號之間必須留空格,否則會被誤認為函式名叫 function。

清單 4. 內部函式宣告

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

可見 _inF() 僅在 outF() 內部有效,區域變數 innerA 對內部函式的作用域也生效。這種寫法讓變數與函式的作用域一目了然。

語句

就簡單語句而言,重點仍是分號的必要性,同時一行最多一個語句。若赋值語句的右側是函式或物件且需跨多行,務必在結尾補上分號。

這麼要求的原因是:JavaScript 中所有運算式都可視為語句,遇到換行時會被解析為語句結束。此時不規範的換行加上遺漏的分號,就可能引入新的錯誤。

至於複合語句——if、for、while、do、switch、try...catch 的程式碼區塊、函式主體、物件定義等——都必須放在大括號中。{ 置於行末代表區塊開始,} 置於行首並與對應的 { 起始位置對齊,代表區塊結束。內部程式碼再縮進 4 個空格。這樣的排版讓控制邏輯清楚可見,可讀性提升顯著。

即使區塊內只有一行,也應該加上大括號。省下來確實不會出錯,但日後要增加語句時,很容易因為忘記補括號而造成編譯或邏輯錯誤。

清單 1. 行結束的位置

<script language="javascript">
var valueA = 1;
var valueB = valueA ///bad
  +1;
var valueC = valueB + ///good
  valueA;
alert(valueB); //output: valueB=2
alert(valueC);//output: valueC=3
</script>

return 語句也需謹慎。若以運算式作為回傳值,請把運算式與 return 放在同一行,以免換行被誤判為語句結束。return 後若沒有值,回傳 undefined;建構函式的預設回傳值則是 this。

清單 5. return 運算式

<script language="javascript">
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
</script>

F2 因為 return 後直接換行,被解析為「回傳 undefined,接著一個無效運算式」,於是得到 undefined。這個錯誤症狀很單純,卻相當難察覺,值得特別留意。

空白符

適當的空行能讓程式碼邏輯更清晰;運算式中留白也有助閱讀。具體建議如下:

  • 關鍵字後若有括號,關鍵字與 ( 之間留空格,如 for、if、while
  • 函式名與括號之間不留空格;但匿名函式的 function 與 ( 之間必須留
  • 二元運算子(除了 (、[、作用域的 .)與兩個運算元之間留空格;一元運算子與運算元之間不留
  • 逗號後留空格,以清楚區隔參數與變數
  • 分號代表語句結束,之後換行;但在 for 的條件句中,分號之後應留空格

{ } 與 [ ]

需要空的物件或陣列時,直覺會寫 new Object() 與 new Array()。其實 {} 與 [] 就能直接定義,寫法更簡潔,也更不容易出錯——尤其 new Array(5) 會產生一個長度 5 的陣列而非含 5 的陣列,是個經典陷阱。

== 與 ===

判斷「邏輯相等」再平常不過,但 JavaScript 提供了兩種寫法。差別在於:== 會先進行型別轉換再比較,=== 則不會。因此 == 的結果可能不如預期。!= 與 !== 的關係亦然。建議一律使用 === 與 !==。

清單 6. === 的使用

<script language="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"
</script>

valueA 是字串、valueB 是數字,兩者型別不同。用 == 比較時,編譯器會自動把 valueB 轉成字串再比對,於是判定相等;=== 的結果才符合預期。

+ 號

加號在 JavaScript 中身兼三職:數字相加、字串串接,以及作為一元運算子把字串轉為數字。使用不當,可能與遞增符號 ++ 混淆而造成錯誤。

清單 7. 巧用 + 號

<script language="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
</script>

第一行輸出 2010 而非 30,因為有字串參與,加號變成串接。(+valueB) 用一元加號先把字串轉為數字,才得到 30。最後一行則因 ++ 被解析為遞增運算子而語法錯誤。程式中若可能混入字串數字,建議明確用 parseFloat 或 Number() 轉型,別依賴一元加號的隱含行為。

總結

本文就 JavaScript 的排版、命名、宣告、語句與特殊字元使用,談了一些編碼規範上的建議。還有許多值得深入研究的題目,例如 with、eval 與 this 的適當用法——前兩者更建議在現代開發中完全避免。

規範的核心從來不是形式主義。這些約定背後多半有具體理由:分號關乎解析規則、宣告關乎作用域、=== 關乎型別轉換。理解原因之後,寫出來的程式碼自然會既整齊又可靠。

聲明:本文所述的建議整理自學習與工作經驗,僅供技術交流參考。

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