32. 代码规范

代码规范通常包括以下几个方面:
变量和函数的命名规则
空格,缩进,注释的使用规则。
其他常用规范……
规范的代码可以更易于阅读与维护。
代码规范一般在开发前规定,可以跟你的团队成员来协商设置。

变量名

变量名推荐使用驼峰法来命名(camelCase):

<xmp>
firstName = "John";
lastName = "Doe";

price = 19.90;
tax = 0.20;

fullPrice = price + (price * tax);
</xmp>

空格与运算符

通常运算符 ( = + – * / ) 前后需要添加空格:

<xmp>
var x = y + z;
var values = ["Volvo", "Saab", "Fiat"];
</xmp>

代码缩进

通常使用 4 个空格符号来缩进代码块:

<xmp>
function toCelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}
</xmp>

不推荐使用 TAB 键来缩进,因为不同编辑器 TAB 键的解析不一样。

语句规则

简单语句的通用规则:一条语句通常以分号作为结束符。

<xmp>
var values = ["Volvo", "Saab", "Fiat"];
</xmp>

复杂语句的通用规则:
将左花括号放在第一行的结尾。
左花括号前添加一空格。
将右花括号独立放在一行。
不要以分号结束一个复杂的声明。

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

函数:

<xmp>
function toCelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}
</xmp>

循环:

<xmp>
for (i = 0; i < 5; i++) {
    x += i;
}
</xmp>

条件语句:

<xmp>
if (time < 20) {
    greeting = "Good day";
} else {
    greeting = "Good evening";
}
</xmp>

对象规则

对象定义的规则:
将左花括号与类名放在同一行。
冒号与属性值间有个空格。
字符串使用双引号,数字不需要。
最后一个属性-值对后面不要添加逗号。
将右花括号独立放在一行,并以分号作为结束符号。

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

命名规则

变量和函数为驼峰法( camelCase)
全局变量为大写 (UPPERCASE )
常量 (如 PI) 为大写 (UPPERCASE )
HTML 和 CSS 的横杠(-)字符:
HTML5 属性可以以 data- (如:data-quantity, data-price) 作为前缀。
CSS 使用 – 来连接属性名 (font-size)。
Note – 通常在 JavaScript 中被认为是减法,所以不允许使用。

下划线:
很多程序员比较喜欢使用下划线(如:date_of_birth), 特别是在 SQL 数据库中。

驼峰法:
JavaScript 中通常推荐使用驼峰法,jQuery 及其他 JavaScript 库都使用驼峰法。

评论

0 条评论