前端規範之Jacascript程式碼規範
Javascript程式碼規範
所有的 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 個空格符號來縮排程式碼塊：
注意：不推薦使用 TAB 鍵來縮排，因為不同編輯器 TAB 鍵的解析不一樣。
函式:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
語句規則
簡單語句的通用規則:
· 一條語句通常以分號作為結束符。
例項:
var values = ["Volvo", "Saab", "Fiat"];
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
複雜語句的通用規則:
· 將左花括號放在第一行的結尾。
· 左花括號前新增一空格。
· 將右花括號獨立放在一行。
· 不要以分號結束一個複雜的宣告。
函式:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
迴圈:
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"
};
短的物件程式碼可以直接寫成一行:
例項:
var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};
每行程式碼字元小於 80
為了便於閱讀每行字元建議小於數 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 中被認為是減法，所以不允許使用。
下劃線:
很多程式設計師比較喜歡使用下劃線(如：date_of_birth), 特別是在 SQL 資料庫中。
PHP 語言通常都使用下劃線。
帕斯卡拼寫法(PascalCase):
帕斯卡拼寫法(PascalCase) 在 C 語言中語言較多。
駝峰法：
JavaScript 中通常推薦使用駝峰法，jQuery 及其他 JavaScript 庫都使用駝峰法。
注意：變數名不要以 $ 作為開始標記，會與很多 JavaScript 庫衝突。
HTML 載入外部 JavaScript 檔案
使用簡潔的格式載入 JavaScript 檔案 ( type 屬性不是必須的):
<script src="myscript.js">
使用 JavaScript 訪問 HTML 元素
一個糟糕的 HTML 格式可能會導致 JavaScript 執行錯誤。
以下兩個 JavaScript 語句會輸出不同結果:
例項
var obj = getElementById("Demo")
var obj = getElementById("demo")
副檔名
HTML 檔案字尾可以是 .html (或r .htm)。
CSS 檔案字尾是 .css 。
JavaScript 檔案字尾是 .js 。
使用小寫檔名
大多 Web 伺服器 (Apache, Unix) 對大小寫敏感： london.jpg 不能通過 London.jpg 訪問。
其他 Web 伺服器 (Microsoft, IIS) 對大小寫不敏感： london.jpg 可以通過 London.jpg 或 london.jpg 訪問。
你必須保持統一的風格，我們建議統一使用小寫的檔名。