以下JS代碼規範整理在W3Cschool。
命名規則
- 變量和函數爲駝峯法（ camelCase）- 第一個字母小寫，後面字母首字母大寫。
- 全局變量爲大寫 (UPPERCASE )
- 常量 (如 PI) 爲大寫 (UPPERCASE )
變量名
- 變量名推薦使用駝峯法來命名(camelCase)
- 變量名應該區分大小寫，允許包含字母、數字、美元符號($)和下劃線，但第一個字符不允許是數字，不允許包含空格和其他標點符號
- 變量命名長度應該儘可能的短，並抓住要點，儘量在變量名中體現出值的類型
- 變量名的命名應該是有意義的
- 變量名不能爲JavaScript中的關鍵詞、保留字全名
空格與運算符
運算符 ( = + - * / ) 前後需要添加空格。
代碼縮進
使用 4 個空格符號來縮進代碼塊。
Note: 不推薦使用 TAB 鍵來縮進，因爲不同編輯器 TAB 鍵的解析不一樣。
語句規則
- 一條語句以分號作爲結束符（簡單語句）
- 將左花括號放在第一行的結尾
- 左花括號前添加一空格
- 將右花括號獨立放在一行
- 不要以分號結束一個複雜的聲明
代碼示例
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
對象規則
- 將左花括號與類名放在同一行
- 冒號與屬性值間有個空格
- 字符串使用雙引號，數字不需要
- 最後一個屬性-值對後面不要添加逗號
- 將右花括號獨立放在一行，並以分號作爲結束符號
- 短的對象代碼可以直接寫成一行
- 每行代碼字符小於 80
代碼示例
var person = {
firstName: "Devin",
lastName: "Xin",
age: 28
};
HTML中載入外部JS文件
省略type 屬性，使用簡潔的格式載入 JavaScript 文件 ：
<script src="myscript.js">
文件擴展名
- HTML 文件後綴可以是 .html (或r .htm)
- CSS 文件後綴是 .css
- JavaScript 文件後綴是 .js
- 使用小寫的文件名