JavaScript 程式碼規(guī)範(fàn)
所有的 JavaScript 專案都適用同一種規(guī)格。
JavaScript 程式碼規(guī)格
#程式碼規(guī)格通常包括以下幾個面向:
-
#變數(shù)和函數(shù)的命名規(guī)則
空格,縮進,註解的使用規(guī)則。
其他常用規(guī)格…
規(guī)格的程式碼可以更容易閱讀與維護。
程式碼規(guī)格一般在開發(fā)前就規(guī)定,可以跟你的團隊成員來協(xié)商設(shè)定。
變數(shù)名稱
#變數(shù)名稱推薦使用駝峰法來命名(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 個空格符號來縮排程式碼區(qū)塊:
函數(shù):
TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用TAB 鍵不建議使用來縮進,因為不同編輯器TAB 鍵的解析不一樣。function?toCelsius(fahrenheit) {
????return?(5?/?9) * (fahrenheit -?32);
}
語句規(guī)則
簡單語句的通用規(guī)則:- 一條語句通常以符號作為結(jié)束符。
var?values = ["Volvo",?"Saab",?"Fiat"];#複雜語句的一般規(guī)則:
var?person = {
??? firstName: "John",
??? lastName:?"Doe",
??? age:?50,
??? eyeColor:?"blue"
};
#複雜語句的一般規(guī)則:
將左花括號放在第一行的結(jié)尾。
左花括號前方新增一空格。
將右花括號獨立放在一行。
不要以分號結(jié)束一個複雜的宣告。
###函數(shù):##########
function?toCelsius(fahrenheit) {
????return?(5?/?9) * (fahrenheit -?32);
}
##for?(i =?0; i <?5; i++) {
??? x += i;}
條件語句:
if?(time <?20) {??? greeting =?"Good day";}?else?{
??? greeting =?" #}?else?{
卷;
}
#物件規(guī)則
#物件定義的規(guī)則:- #將左花括號與類別名稱放在同一行。
- 冒號與屬性值間有個空格。
- 字串使用雙引號,數(shù)字不需要。
- 最後一個屬性-值對後面不要加上逗號。
- 將右花括號獨立放在一行,並以符號作為結(jié)束符號。
var?person = {短的物件程式碼可以直接寫成一行:??? firstName:?"John",
??? lastName:?"Doe",
??? age:#50,##?eyeColor:?"blue"
};
var?person = {firstName:" John", lastName:"Doe", age:50, eyeColor:"blue"};
每行程式碼字元小於80
#為了方便閱讀每行字元建議小於數(shù)80 個。
如果一個 JavaScript 語句超過了 80 個字符,建議在 運算子或逗號後換行。
實例
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>php中文網(wǎng)(php.cn)</title> </head> <body> <h1>我的 Web 頁面</h1> <p> 建議在運算符或者逗號后換行。 </p> <p id="demo"></p> <script> document.getElementById("demo").innerHTML = "Hello php."; </script> </body> </html>
運行程式嘗試
命名規(guī)則# 一般很多程式碼語言的命名規(guī)則都是類似的,例如: 變數(shù)和函數(shù)為駝峰法(?camelCase) 全域變數(shù)為大寫(UPPERCASE?) 常數(shù)(如PI) 為大寫(UPPERCASE?) ?hyp-hens,?camelCase, 或?under_scores?? HTML 和CSS 的橫桿(-)字元: 注意: - 通常在 JavaScript 中被認(rèn)為是減法,所以不允許使用。 ? ? 底線: 帕斯卡拼字法(PascalCase): 駝峰法: 注意:變數(shù)名稱不要以 $ 作為開始標(biāo)記,會與許多 JavaScript 函式庫衝突。 HTML 載入外部JavaScript 檔案 使用JavaScript 存取HTML 元素
##變數(shù)命名你是否使用這幾種規(guī)則:<script?src="myscript.js">
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文網(wǎng)(php.cn)</title>
</head>
<body>
<p id="Demo">段落 1。</p>
<p id="demo">段落 2。</p>
<script>
// 只有段落 2 會被替換
document.getElementById("demo").innerHTML = "HELLO.";
</script>
</body>
</html>
提示:HTML 與JavaScript 盡量使用相同的命名規(guī)則。
檔案副檔名
HTML 檔案後綴可以是?.html?(或r?.htm)。
CSS 檔案後綴是?.css#?。
JavaScript 檔案後綴是?.js?#。
#使用小寫檔案名稱
大多 Web 伺服器 (Apache, Unix) 對大小寫敏感: london.jpg 不能透過 London.jpg 存取。
其他 Web 伺服器 (Microsoft, IIS) 對大小寫不敏感: london.jpg 可以透過 London.jpg 或 london.jpg 存取。
你必須保持統(tǒng)一的風(fēng)格,我們建議統(tǒng)一使用小寫的檔案名稱。