以下JS代码规范整理在W3Cschool。
命名规则
- 变量和函数为驼峰法( camelCase)- 第一个字母小写,后面字母首字母大写。
- 全局变量为大写 (UPPERCASE )
- 常量 (如 PI) 为大写 (UPPERCASE )
变量名
- 变量名推荐使用驼峰法来命名(camelCase)
- 变量名应该区分大小写,允许包含字母、数字、美元符号($)和下划线,但第一个字符不允许是数字,不允许包含空格和其他标点符号
- 变量命名长度应该尽可能的短,并抓住要点,尽量在变量名中体现出值的类型
- 变量名的命名应该是有意义的
- 变量名不能为JavaScript中的关键词、保留字全名
空格与运算符
运算符 ( = + - * / ) 前后需要添加空格。
代码缩进
使用 4 个空格符号来缩进代码块。
Note: 不推荐使用 TAB 键来缩进,因为不同编辑器 TAB 键的解析不一样。
语句规则
- 一条语句以分号作为结束符(简单语句)
- 将左花括号放在第一行的结尾
- 左花括号前添加一空格
- 将右花括号独立放在一行
- 不要以分号结束一个复杂的声明
代码示例
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
对象规则
- 将左花括号与类名放在同一行
- 冒号与属性值间有个空格
- 字符串使用双引号,数字不需要
- 最后一个属性-值对后面不要添加逗号
- 将右花括号独立放在一行,并以分号作为结束符号
- 短的对象代码可以直接写成一行
- 每行代码字符小于 80
代码示例
var person = {
firstName: "Devin",
lastName: "Xin",
age: 28
};
HTML中载入外部JS文件
省略type 属性,使用简洁的格式载入 JavaScript 文件 :
<script src="myscript.js">
文件扩展名
- HTML 文件后缀可以是 .html (或r .htm)
- CSS 文件后缀是 .css
- JavaScript 文件后缀是 .js
- 使用小写的文件名