DIV CSS 佈局教程網

JavaScript 程式編碼規範要點整理
編輯:關於JavaScript     

軟體的長期價值直接來自程式碼品質。在它整個生命週期裡,一份程式可能會被很多人閱讀與修改;如果它能清楚展現自己的結構與特徵,日後出錯的機率就會降低。編碼規範正是用來提升程式健壯性的工具。

所有 JavaScript 程式碼都是暴露在公眾面前的,因此更應該講究整潔。

JavaScript 檔案

JavaScript 程式應獨立保存在副檔名為 .js 的檔案中。

除非是專屬於該頁面的片段,否則不應把 JavaScript 寫進 HTML。內嵌程式碼會明顯增加檔案大小,而且無法被快取與壓縮。

filename.js 應盡量放到 body 的後面,這樣可以減少 script 載入延誤其他內容的問題。也不必使用 language 或 type 屬性,MIME 型別是由伺服器而非 script 標籤決定的。

縮排

縮排單位為四個空格。避免使用 Tab(即使已是 21 世紀),因為始終沒有一個統一的 Tab 寬度標準。使用空格雖會增加檔案大小,但在區域網路中幾乎可忽略,且縮小化過程中也會被消除。

每行長度

避免每行超過 80 個字元。一行寫不下時請考慮折行,最好在運算子或逗號之後換行。在運算子後換行,可減少複製貼上造成的錯誤被分號掩蓋的機率。下一行應縮排八個空格。

註解

不要吝嗇註解。為之後需要理解程式碼的人(很可能就是你自己)留下資訊非常有用。註解應與它所註解的程式碼一樣清晰。偶爾的小幽默不錯,但要避免冗長或情緒化。

及時更新註解同樣重要,錯誤的註解會讓程式更難讀懂。註解要有意義,重點放在解釋那些不易一眼看懂的邏輯,別把讀者的時間浪費在這種事上:

i = 0; // 讓 i 等於 0

使用單行註解,區塊註解則用於正式文件與暫停使用的程式碼。

變數宣告

所有變數必須在使用前宣告。JavaScript 不強制這麼做,但這麼做可讓程式易讀,也易於發現漏掉的宣告(它們會被編譯成全域變數)。

最好把每個變數的宣告各自獨立一行並加上說明,所有變數依字母排序:

var currentEntry; // 當前選擇項
var level;        // 縮排程度
var size;         // 表格大小

JavaScript 沒有區塊作用域,在區塊內定義變數容易讓 C/C++/Java 工程師誤解,因此應在函式開頭定義所有變數。

盡量減少全域變數的使用,不要讓區域變數覆蓋全域變數。

函式宣告

所有函式在使用前宣告,內層函式的宣告跟在 var 語句之後,如此有助判斷哪些變數屬於函式範圍。

函式名與左括號之間不應有空格;右括號與開始函式主體的左大括號之間應插入一個空格;函式主體縮排四個空格;右大括號與函式宣告那一行的開頭對齊。

function outer(c, d) {
    var e = c * d;

    function inner(a, b) {
        return (e * a) + b;
    }

    return inner(0, 1);
}

下面這種寫法在 JavaScript 中完全合法,因為函式與物件的宣告可以放在任何表達式允許的地方,而且它讓內嵌函式與混合結構具有最佳可讀性:

function getElementsByClassName(className) {
    var results = [];
    walkTheDOM(document.body, function (node) {
        var a;              // 類名陣列
        var c = node.className; // 節點的類名
        var i;              // 迴圈計數器

        // 若節點有類名,拆成單一名稱清單;
        // 任一符合需求時,就把節點加入結果集
        if (c) {
            a = c.split(' ');
            for (i = 0; i < a.length; i += 1) {
                if (a[i] === className) {
                    results.push(node);
                    break;
                }
            }
        }
    });
    return results;
}

如果是匿名函式,function 與左括號之間應有一個空格,否則會讓人誤以為函式名叫 function:

div.onclick = function (e) {
    return false;
};

that = {
    method: function () {
        return this.datum;
    },
    datum: 0
};

盡量不使用全域函式。

命名

變數名應由 26 個英文字母(A..Z、a..z)、10 個數字(0..9)與底線組成。避免使用國際化字元(如中文),因為它們不是在任何環境都能被方便閱讀理解。命名中不要使用 $ 或反斜線。

不要把底線作為變數名的首字元。它有時被用來表示私有變數,但 JavaScript 並未提供私有變數功能;若私有性很重要,應使用私有成員的形式,避免這種容易誤導的命名習慣。

多數變數名與方法名應以小寫字母開頭。必須與 new 一起使用的建構子名應以大寫字母開頭——忘記加 new 時 JavaScript 不會有任何編譯或執行錯誤,卻容易引出難查的問題,因此大寫建構子名是我們唯一的防線。

全域變數應全部大寫(JavaScript 沒有宏或常數,不會因此造成誤會)。

語句

簡單語句

每行最多一條語句,並在每條簡單語句結尾加上分號。注意函式指派或物件指派也是指派語句,應以分號結尾。

JavaScript 可以把任何表達式當成語句,這容易藏錯,尤其是誤加分號。只有在指派與呼叫時,表達式才應被當作獨立語句。

複合語句

複合語句是被包在 { } 中的語句序列:

  • 被包住的語句必須多縮排四個空格
  • 左大括號應在複合語句開頭的結尾處
  • 右大括號應與左大括號那一行的開頭對齊
  • 即使只有一條語句,只要它是控制結構(if、for 等)的一部分,就應該加上大括號,以避免日後新增語句時出錯

標示

語句標示是可選的,只有 while、do、for、switch 必須標示。

return 語句

有回傳值的 return 不要用括號包住回傳值。若回傳表達式,表達式應與 return 在同一行,以避免誤加分號的錯誤。

if 語句

if (condition) {
    statements;
}

if (condition) {
    statements;
} else {
    statements;
}

if (condition) {
    statements;
} else if (condition) {
    statements;
} else {
    statements;
}

for 語句

for (initialization; condition; update) {
    statements;
}

for (variable in object) {
    if (filter) {
        statements;
    }
}

第一種形式用於已知相關參數的陣列迴圈;第二種用於物件。object 原型中的成員也會被納入迭代,因此用 hasOwnProperty 過濾出真正的物件成員是個好方法:

for (variable in object) {
    if (object.hasOwnProperty(variable)) {
        statements;
    }
}

while 與 do 語句

while (condition) {
    statements;
}

do {
    statements;
} while (condition);

不像其他複合語句,do 語句總是以分號結尾。

switch 語句

switch (expression) {
case expression:
    statements;
default:
    statements;
}

每個 case 與 switch 對齊,可避免過度縮排。每一組 statements(除了 default)都應以 break、return 或 throw 結尾,不要讓它順流而下。

try 語句

try {
    statements;
} catch (variable) {
    statements;
}

try {
    statements;
} catch (variable) {
    statements;
} finally {
    statements;
}

continue 語句

避免使用 continue,它容易讓程式邏輯變得晦澀難懂。

with 語句

不要使用 with 語句。

空白

用空行分隔邏輯相關的程式碼區塊可提高可讀性。空格應在以下情況使用:

  • 跟在左括號後的關鍵字應以一個空格隔開,例如 while (true) {
  • 函式參數與左括號之間不應有空格,有助區分關鍵字與函式呼叫
  • 所有二元運算子(除了 . 、( 、[ )都應用空格與運算元隔開
  • 一元運算子與其運算元之間不應有空格,除非運算子是單字(如 typeof)
  • 控制部分(如 for 語句)中的每個分號後須跟一個空格
  • 每個逗號後應跟一個空格

其他建議

{} 與 []

使用 {} 代替 new Object(),使用 [] 代替 new Array()。當成員名是一組有序數字時用陣列保存資料;當成員名是無規律字串或其他時用物件保存。

逗號運算子

避免使用逗號運算子,除非在特定 for 語句的控制部分(不包括物件定義、陣列定義、var 語句與參數列表中的逗號分隔符)。

作用域

JavaScript 中區塊沒有作用域,只有函式有。除非在複合語句中,否則不要使用區塊。

指派表達式

避免在 if 與 while 的條件部分進行指派:

if (a = b) {

這到底是正確語句,還是本該寫成 if (a == b) {?避免這種難以判斷對錯的結構。

=== 與 !== 運算子

優先用 === 與 !==。== 與 != 會進行型別強制轉換,尤其不要將 == 用於與 0、""、false、null、undefined、NaN 比較。

易混淆的加減號

小心 + 後緊跟 + 或 ++,這種形式容易讓人困惑,應插入括號:

total = subtotal + +myInput.value;

最好寫成:

total = subtotal + (+myInput.value);

這樣 ++ 不會被誤認為遞增運算子。

eval 是惡魔

eval 是 JavaScript 中最容易被濫用的方法,避免使用。它有別名:不要使用 Function 建構子,也不要給 setTimeout 或 setInterval 傳遞字串參數。

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