JavaScript 代码规范

Posted 2021-03-19 艺术诗人

代码规范通常包括以下几个方面:

• 变量和函数的命名规则
• 空格，缩进，注释的使用规则。
• 其他常用规范……

1、变量的正确命名

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

2、运算符前后合理使用空格

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

3、代码缩进，增加代码可读性

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

　　为什么不适用Tab键的原因：不同编辑器 TAB 键的解析不一样。

4、语句规则

简单语句的通用规则:

• 一条语句通常以分号作为结束符。

  var values = ["Volvo", "Saab", "Fiat"];
  
  var person = {
      firstName: "John",
      lastName: "Doe",
      age: 50,
      eyeColor: "blue"
  };

复杂语句的通用规则:

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

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

对象定义的规则:

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

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

5、每行代码字符小于 80

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

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

document.getElementById("demo").innerhtml =
    "Hello Runoob.";

6、命名规则

一般很多代码语言的命名规则都是类似的，例如:

• 变量和函数为小驼峰法标识, 即除第一个单词之外，其他单词首字母大写（ lowerCamelCase）
• 全局变量为大写 (UPPERCASE )
• 常量 (如 PI) 为大写 (UPPERCASE )

变量命名你是否使用这几种规则： hyp-hens, camelCase, 或 under_scores ?

HTML 和 CSS 的横杠(-)字符:

HTML5 属性可以以 data- (如：data-quantity, data-price) 作为前缀。

CSS 使用 - 来连接属性名 (font-size)。

下划线:

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

php 语言通常都使用下划线。

帕斯卡拼写法(PascalCase):

帕斯卡拼写法(PascalCase) 在 C 语言中语言较多。

驼峰法：

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