JavaScript 代碼規範
所有的JavaScript 項目適用同一種規範。
JavaScript 代碼規範
代碼規範通常包括以下幾個方面:
- 變量和函數的命名規則
- 空格，縮進，註釋的使用規則。
- 其他常用規範……
規範的代碼可以更易於閱讀與維護。
代碼規範一般在開發前規定，可以跟你的團隊成員來協商設置。
變量名
變量名推薦使用駝峰法來命名( camelCase ):
lastName = "Doe" ;
price = 19.90 ;
tax = 0.20 ;
fullPrice = price + (price * tax);
空格與運算符
通常運算符( = + - * / ) 前後需要添加空格:
實例:
var values = [ "Volvo" , "Saab" , "Fiat" ];
代碼縮進
通常使用4 個空格符號來縮進代碼塊：
函數:
return ( 5 / 9 ) * (fahrenheit - 32 );
}
 | 不推薦使用TAB 鍵來縮進，因為不同編輯器TAB 鍵的解析不一樣。 |
|---|
語句規則
簡單語句的通用規則:
- 一條語句通常以符號作為結束符。
實例:
var person = {
firstName: "John" ,
lastName: "Doe" ,
age: 50 ,
eyeColor: "blue"
};
複雜語句的通用規則:
- 將左花括號放在第一行的結尾。
- 左花括號前添加一空格。
- 將右花括號獨立放在一行。
- 不要以分號結束一個複雜的聲明。
函數:
return ( 5 / 9 ) * (fahrenheit - 32 );
}
循環:
x += i;
}
條件語句:
greeting = "Good day" ;
} else {
greeting = "Good evening" ;
}
對象規則
對象定義的規則:
- 將左花括號與類名放在同一行。
- 冒號與屬性值間有個空格。
- 字符串使用雙引號，數字不需要。
- 最後一個屬性-值對後面不要添加逗號。
- 將右花括號獨立放在一行，並以符號作為結束符號。
實例:
firstName: "John" ,
lastName: "Doe" ,
age: 50 ,
eyeColor: "blue"
};
短的對象代碼可以直接寫成一行:
實例:
每行代碼字符小於80
為了便於閱讀每行字符建議小於數80 個。
如果一個JavaScript 語句超過了80 個字符，建議在運算符或者逗號後換行。
命名規則
一般很多代碼語言的命名規則都是類似的，例如:
- 變量和函數為駝峰法（ camelCase ）
- 全局變量為大寫( UPPERCASE )
- 常量(如PI)為大寫( UPPERCASE )
變量命名你是否使用這幾種規則： hyp-hens , camelCase ,或under_scores ?
HTML和CSS的橫槓(-)字符:
HTML5 屬性可以以data- (如：data-quantity, data-price) 作為前綴。
CSS 使用- 來連接屬性名(font-size)。
| - 通常在JavaScript 中被認為是減法，所以不允許使用。 |
|---|
下劃線:
很多程序員比較喜歡使用下劃線(如：date_of_birth), 特別是在SQL 數據庫中。
PHP 語言通常都使用下劃線。
帕斯卡拼寫法(PascalCase):
帕斯卡拼寫法(PascalCase) 在C 語言中語言較多。
駝峰法：
JavaScript 中通常推薦使用駝峰法，jQuery 及其他JavaScript 庫都使用駝峰法。
| 變量名不要以$ 作為開始標記，會與很多JavaScript 庫衝突。 |
|---|
HTML 載入外部JavaScript 文件
使用簡潔的格式載入JavaScript 文件( type 屬性不是必須的):
使用JavaScript 訪問HTML 元素
一個糟糕的HTML 格式可能會導致JavaScript 執行錯誤。
以下兩個JavaScript 語句會輸出不同結果:
HTML 與JavaScript 盡量使用相同的命名規則。
文件擴展名
HTML文件後綴可以是.html (或r .htm )。
CSS文件後綴是.css 。
JavaScript文件後綴是.js 。
使用小寫文件名
大多Web 服務器(Apache, Unix) 對大小寫敏感： london.jpg 不能通過London.jpg 訪問。
其他Web 服務器(Microsoft, IIS) 對大小寫不敏感： london.jpg 可以通過London.jpg 或london.jpg 訪問。
你必須保持統一的風格，我們建議統一使用小寫的文件名。