天天看點

JavaScript 代碼規範

所有的 JavaScript

項目适用同一種規範。

代碼規範通常包括以下幾個方面:

變量和函數的命名規則

空格,縮進,注釋的使用規則。

其他常用規範……

規範的代碼可以更易于閱讀與維護。

代碼規範一般在開發前規定,可以跟你的團隊成員來協商設定。

變量名推薦使用駝峰法來命名(camelCase):

firstName = "John";

lastName = "Doe";

price = 19.90;

tax = 0.20;

fullPrice = price + (price * tax);

通常運算符 ( = + - * / ) 前後需要添加空格:

var x = y + z;

var values = ["Volvo", "Saab",

"Fiat"];

通常使用 4 個空格符号來縮進代碼塊:

function toCelsius(fahrenheit) {

    return (5 / 9) * (fahrenheit - 32);

}

JavaScript 代碼規範

不推薦使用 TAB 鍵來縮進,因為不同編輯器 TAB 鍵的解析不一樣。

簡單語句的通用規則:

一條語句通常以分号作為結束符。

var person = {

    firstName: "John",

lastName: "Doe",

    age: 50,

    eyeColor:

"blue"

};

複雜語句的通用規則:

将左花括号放在第一行的結尾。

左花括号前添加一空格。

将右花括号獨立放在一行。

不要以分号結束一個複雜的聲明。

for (i = 0; i < 5; i++) {

    x += i;

if (time < 20) {

    greeting = "Good day";

} else {

greeting = "Good evening";

對象定義的規則:

将左花括号與類名放在同一行。

冒号與屬性值間有個空格。

字元串使用雙引号,數字不需要。

最後一個屬性-值對後面不要添加逗号。

将右花括号獨立放在一行,并以分号作為結束符号。

短的對象代碼可以直接寫成一行:

var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};

為了便于閱讀每行字元建議小于數 80 個。

如果一個 JavaScript 語句超過了 80 個字元,建議在 運算符或者逗号後換行。

document.getElementById("demo").innerHTML =

    "Hello Runoob.";

一般很多代碼語言的命名規則都是類似的,例如:

變量和函數為小駝峰法辨別, 即除第一個單詞之外,其他單詞首字母大寫( lowerCamelCase)

全局變量為大寫 (UPPERCASE )

常量 (如 PI) 為大寫 (UPPERCASE )

變量命名你是否使用這幾種規則: hyp-hens, camelCase, 或

under_scores ?

HTML 和 CSS 的橫杠(-)字元:

HTML5 屬性可以以 data- (如:data-quantity, data-price) 作為字首。

CSS 使用 - 來連接配接屬性名 (font-size)。

JavaScript 代碼規範

- 通常在 JavaScript 中被認為是減法,是以不允許使用。

下劃線:

很多程式員比較喜歡使用下劃線(如:date_of_birth), 特别是在 SQL

資料庫中。

PHP 語言通常都使用下劃線。

帕斯卡拼寫法(PascalCase):

帕斯卡拼寫法(PascalCase) 在 C 語言中語言較多。

駝峰法:

JavaScript 中通常推薦使用駝峰法,jQuery 及其他 JavaScript 庫都使用駝峰法。

JavaScript 代碼規範

變量名不要以 $ 作為開始标記,會與很多 JavaScript 庫沖突。

使用簡潔的格式載入 JavaScript 檔案 ( type 屬性不是必須的):

<script src="myscript.js">

一個糟糕的 HTML 格式可能會導緻 JavaScript 執行錯誤。

以下兩個 JavaScript 語句會輸出不同結果:

var obj =

getElementById("Demo")

var obj = getElementById("demo")

HTML 與 JavaScript 盡量使用相同的命名規則。

通路 HTML(5) 代碼規範。

HTML 檔案字尾可以是 .html (或 .htm)。

CSS 檔案字尾是 .css 。

JavaScript 檔案字尾是 .js 。

大多 Web 伺服器 (Apache, Unix) 對大小寫敏感: london.jpg 不能通過 London.jpg 通路。

其他 Web 伺服器 (Microsoft, IIS) 對大小寫不敏感: london.jpg 可以通過 London.jpg 或 london.jpg 通路。

你必須保持統一的風格,我們建議統一使用小寫的檔案名。