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 個空格符號來縮排程式碼區塊：
函數:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
不建議使用TAB 鍵來縮進，因為不同編輯器TAB 鍵的解析不一樣。
語句規則
簡單語句的一般規則:
一條語句通常以符號作為結束符號。
實例:
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,## "
};
短的物件程式碼可以直接寫成一行:
實例:
var person = {firstName:"John", lastName:"Doe" , age:50, eyeColor:"blue"};
每行程式碼字元小於80
為了方便閱讀每行字元建議小於數80 個。
如果一個 JavaScript 語句超過了 80 個字符，建議在 運算子或逗號後換行。
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<h1>我的 Web 页面</h1>
<p>
建议在运算符或者逗号后换行。
</p>
<p id="demo"></p>
<script>
document.getElementById("demo").innerHTML =
"Hello php.";
</script>
</body>
</html>命名規則
一般很多程式語言的命名規則都是類似的，例如:
變數和函數為駝峰法（ 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 屬性不是必須的):
< ;script src="myscript.js">
使用JavaScript 存取HTML 元素
一個糟糕的HTML 格式可能會導致JavaScript 執行錯誤。
以下兩個 JavaScript 語句會輸出不同結果:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<p id="Demo">段落 1。</p>
<p id="demo">段落 2。</p>
<script>
// 只有段落 2 会被替换
document.getElementById("demo").innerHTML = "HELLO.";
</script>
</body>
</html>檔案副檔名
HTML 檔案後綴可以是 .html (或r .htm)。
CSS 檔案後綴是 .css 。
JavaScript 檔案後綴是 .js 。
使用小寫檔名
大多 Web 伺服器 (Apache, Unix) 對大小寫敏感： london.jpg 不能透過 London.jpg 存取。
其他 Web 伺服器 (Microsoft, IIS) 對大小寫不敏感： london.jpg 可以透過 London.jpg 或 london.jpg 存取。
你必須保持統一的風格，我們建議統一使用小寫的檔案名稱。
下一節