javascript代码规范

javascript代码规范

转自： 点击打开链接

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,
    eyeColor: "blue"
};

短的对象代码可以直接写成一行:

实例:

var person = {firstName: "John", lastName: "Doe", age: 50, eyeColor: "blue"};

---

每行代码字符小于 80

为了便于阅读每行字符建议小于数 80 个。

如果一个 JavaScript 语句超过了 80 个字符，建议在 运算符或者逗号后换行。