JavaScript

JS 代码规范

• 所有的 JS 项目适用同一种规范

JS 代码规范

• 代码规范通常包括以下几个方面
  • 变量和函数的命名规则
  • 空格、缩进、注释的使用规则
  • 其它常用规范
• 代码规范一般在开发前规定，可以跟你的团队成员来协商设置

变量名

• 变量名推荐用驼峰法来命名（camelCase）

firstName = "John";
lastName = "Doe";

price = 19.98;
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 < 10; 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 个
• 如果一个 JS 语句超过了 80 个字符，建议在运算符或者逗号后换行

document.getElementById("demo").innerHTML = 
    "Hello World";

命名规则

• 一般很多代码语言的命名规则都是类似的，例如：
  • 变量和函数使用驼峰法命名，即除第一个单词之外，其他单词首字母大写（lowerCamelCase）
  • 全局变量为大写（UPPERCASE）
  • 常量（例如 PI）为大写（UPPERCASE）
• 变量命名还可以使用下划线（under_scores）
• HTML 和 CSS 的横杠（-）字符
  • HTML5 属性可以用 data-（例如：data-quantity，data-price）作为前缀
  • CSS 使用 - 来连接属性名（font-size）
  • 横杠 - 在 JS 中通常认为是减法，所以在 JS 中不允许使用横杠 - 来命名变量和函数
• 变量名不要以 $ 作为开始标记，会和很多 JS 库冲突

文件扩展名

• HTML 文件后缀可以是 .html 或者 .htm
• CSS 文件名后缀是 .css
• JavaScrippt 文件后缀是 .js

使用小写文件名

• 大多 Web 服务器 (Apache, Unix) 对大小写敏感： london.jpg 不能通过 London.jpg 访问
• 其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感： london.jpg 可以通过 London.jpg 或 london.jpg 访问
• 你必须保持统一的风格，我们建议统一使用小写的文件名