JavaScript 程式碼規(guī)範(fàn)
JavaScript 程式碼規(guī)格
所有的 JavaScript 專案都適用同一種規(guī)格。
JavaScript 程式碼規(guī)格
程式碼規(guī)格通常包括以下幾個方面:
變數(shù)和函數(shù)的命名規(guī)則
空格，縮進(jìn)，註解的使用規(guī)則。
其他常用規(guī)範(fàn)…
規(guī)範(fàn)的程式碼可以更容易閱讀與維護(hù)。
程式碼規(guī)格一般在開發(fā)前就規(guī)定，可以跟你的團(tuán)隊成員來協(xié)商設(shè)定。
變數(shù)名稱
變數(shù)名稱建議使用駝峰法來命名(camelCase):
firstName =?"John";
lastName =?"Doe";
price =?19.90;
tax =?0.20;
fullPrice = price + (price * tax);
空格與運(yùn)算子
#通常運(yùn)算子( = + - * / ) 前後需增加空格:
實例:
var?x = y + z;
var?values = ["Volvo",?"Saab",?"Fiat" ];
程式碼縮排
通常使用4 個空格符號來縮排程式碼區(qū)塊：
函數(shù):
function?toCelsius(fahrenheit) {
????return?(5?/?9) * (fahrenheit -?32);
}
不建議使用TAB 鍵來縮進(jìn)，因為不同編輯器TAB 鍵的解析不一樣。 ? ?
語句規(guī)則
簡單語句的一般規(guī)則:
一條語句通常以符號作為結(jié)束符號。
實例:
var?values = ["Volvo",?"Saab",?"Fiat"];
var?person = {
??? firstName:?"John",
??? lastName:?"Doe",
??? age:?50,
??? eyeColor:?"blue"
};
複雜語句的通用規(guī)則:
將左花括號放在第一行的結(jié)尾。
左花括號前方新增一空格。
將右花括號獨(dú)立放在一行。
不要以分號結(jié)束一個複雜的宣告。
函數(shù):
function?toCelsius(fahrenheit) {
????return?(5?/?9) * (fahrenheit -?32);
}
循環(huán):
for?(i =?0; i <?5; i++) {
??? x += i;
}
最後一個屬性-值對後面不要加上逗號。
將右花括號獨(dú)立放在一行，並以符號作為結(jié)束符號。
實例:
var?person = {
??? firstName:?"John",
??? lastName:?"Doe",
??? age:?50,##??"
};
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<h1>我的 Web 頁面</h1>
<p>
建議在運(yùn)算符或者逗號后換行。
</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?)變數(shù)命名你是否使用這幾種規(guī)則：?hyp-hens,?camelCase , 或?under_scores??HTML 和CSS 的橫桿(-)字元:HTML5 屬性可以以data- (如：data-quantity, data-price) 作為前綴。 CSS 使用 - 來連接屬性名稱 (font-size)。<!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 存取。
你必須保持統(tǒng)一的風(fēng)格，我們建議統(tǒng)一使用小寫的檔案名稱。
