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 个字符,建议在 运算符或者逗号后换行。

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

亲自试试


命名规则

命名的方法通常有以下几类:

  • camel命名法,形如thisIsAnApple
  • pascal命名法,形如ThisIsAnApple
  • 下划线命名法,形如this_is_an_apple ·
  • 中划线命名法,形如this-is-an-apple

根据不同类型的内容,必须严格采用如下的命名法:

变量名:必须使用camel命名法

参数名:必须使用camel命名法

函数名:必须使用camel命名法

方法/属性:必须使用camel命名法

私有(保护)成员:必须以下划线_开头

常量名:必须使用全部大写的下划线命名法,如IS_DEBUG_ENABLED

类名:必须使用pascal命名法

枚举名:必须使用pascal命名法

枚举的属性:必须使用全部大写的下划线命名法

命名空间:必须使用camel命名法

语义:命名同时还需要关注语义,如:

  • 变量名应当使用名词;
  • boolean类型的应当使用is、has等起头,表示其类型;
  • 函数名应当用动宾短语;
  • 类名应当用名词。

提示:变量名不要以 $ 作为开始标记,会与很多 JavaScript 库冲突。


HTML 载入外部 JavaScript 文件

使用简洁的格式载入 JavaScript 文件 ( type 属性不是必须的):

<script src="myscript.js">

使用 JavaScript 访问 HTML 元素

一个糟糕的 HTML 格式可能会导致 JavaScript 执行错误。

以下两个 JavaScript 语句会输出不同结果:

var obj = getElementById("Demo")
var obj = getElementById("demo")

亲自试试

HTML 与 JavaScript 尽量使用相同的命名规则。

访问 HTML(5) 代码规范


文件扩展名

HTML 文件后缀可以是 .html (或 .htm)。

CSS 文件后缀是 .css

JavaScript 文件后缀是 .js


使用小写文件名

大多 Web 服务器 (Apache, Unix) 对大小写敏感: london.jpg 不能通过 London.jpg 访问。

其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感: london.jpg 可以通过 London.jpg 或 london.jpg 访问。

你必须保持统一的风格,我们建议统一使用小写的文件名。


相关