萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript 編碼規範指南:排版、命名、宣告、作用域與註解

前言

JavaScript 語法鬆散,若無規範極易產生維護噩夢。本文依據業界慣例與經驗,提出檔案引用、縮排、註解、命名、宣告、語句、作用域等規範建議。

1. JavaScript 檔案引用

  • 程式碼盡量置於獨立 .js 檔,HTML 中以 <script src="...></script> 引用。
  • 避免在 HTML 內嵌大量腳本,利於快取與維護。

2. 縮排與排版

  • **統一使用 4 個空格** 縮排,**禁止使用 Tab 鍵**(不同編輯器解寬度不同)。
  • 建議在編輯器設定「Tab = 4 spaces」。
  • 每行最多一條語句;長運算式換行時,運算子置於行首,結尾加分號。

3. 註解規範

  • // 用於單行/行尾註解;/* ... */ 用於區塊註解、函式/檔案標頭說明。
  • 註解須**及時更新**,避免誤導(如複製貼上忘記修改數值)。
  • 重點說明「為什麼」而非「做什麼」;直觀程式碼無需註解。
// 好:解釋業務邏輯
// 等待 50 秒後執行 f1(非設定超時時間)
setTimeout(f1, 50000);

// 差:重複程式碼字面意義
// 將 valueA 初始化為 0
var valueA = 0;

4. 標識符命名

  • 變數、參數、成員、函式:**小駝峰** camelCase,首字母小寫。
  • 建構子/類別:**大駝峰** PascalCase。
  • 常數:UPPER_SNAKE_CASE。
  • 私有/內部成員可以下劃線開頭 _private;避免使用 $ 開頭(保留給系統/框架)。

5. 變數宣告

  • **務必使用 var/let/const 宣告**,避免隱性全域變數。
  • 函式開頭集中宣告區域變數,按字母排序,每行一個,附註解。
  • 範例:
function example() {
  var count = 0;      // 計數器
  var userName = "";  // 使用者名稱
  // ...
}

6. 函式宣告

  • 函式名與左括號緊貼:function foo();匿名函式 function () 之間留空格。
  • 右括號與左大括號之間留一空格:function foo() {。
  • 內部函式置於變數宣告之後,明確作用域。

7. 作用域示範

var innerA = 1; // 全域
function outF() {
  var innerA = 2; // 區域,遮蔽全域
  function inF() {
    alert(innerA); // 2(閉包捕捉區域變數)
  }
  inF();
}
outF();
alert(innerA); // 1(全域未被修改)

8. 復合語句大括號風格

  • { 置於行尾,} 獨立一行並與對應 { 對齊。
  • 區塊內容再縮排 4 空格。
  • 即使只有一條語句,也建議保留大括號,防止後續修改錯誤。
copyright © 萬盛學電腦網 all rights reserved