JavaScript 编码规范
所有 JavaScript 项目请始终使用相同的编码规范。
JavaScript 编码规范
编码规范是编程的风格指南。它们通常涵盖：
- 变量和函数的命名及声明规则。
- 空格、缩进和注释的使用规则。
- 编程实践和原则。
编码规范确保质量：
- 提高代码可读性
- 使代码维护更容易
编码规范可以是团队遵循的文档化规则，也可以只是您个人的编码习惯。
本页介绍了 W3Schools 使用的通用 JavaScript 编码规范。
您还应该阅读下一章“最佳实践”，了解如何避免编码陷阱。
变量名
在 W3schools，我们使用 驼峰式命名法 (camelCase) 作为标识符名称（变量和函数）。
所有名称都以字母开头。
在本页底部，您将找到关于命名规则的更广泛讨论。
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);
运算符周围的空格
始终在运算符（= + - * /）周围和逗号后添加空格
示例
let x = y + z;
const myArray = ["Volvo", "Saab", "Fiat"];
代码缩进
代码块缩进始终使用 2 个空格
函数
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
请勿使用制表符进行缩进。不同的编辑器对制表符的解释不同。
语句规则
简单语句的通用规则
- 简单语句始终以分号结束。
示例
const cars = ["Volvo", "Saab", "Fiat"];
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
复杂（复合）语句的通用规则
- 将开括号放在第一行的末尾。
- 在开括号前使用一个空格。
- 将闭括号放在新行上，不带前导空格。
- 复杂语句不以分号结束。
函数
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
循环
for (let i = 0; i < 5; i++) {
x += i;
}
条件语句
if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}
对象规则
对象定义的通用规则
- 将开括号放在对象名称的同一行。
- 在每个属性及其值之间使用冒号加一个空格。
- 字符串值使用引号，数字值不使用引号。
- 最后一个属性-值对后不加逗号。
- 将闭括号放在新行上，不带前导空格。
- 对象定义始终以分号结束。
示例
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
短对象可以压缩写在一行上，只在属性之间使用空格，如下所示
const person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};
行长度 < 80
为提高可读性，避免行长超过 80 个字符。
如果 JavaScript 语句不适合一行，最佳换行位置是在运算符或逗号之后。
命名约定
始终对所有代码使用相同的命名约定。例如：
- 变量和函数名称以驼峰式命名法 (camelCase) 编写
- 全局变量以大写字母 (UPPERCASE) 编写（我们不这样做，但这很常见）
- 常量（如 PI）以大写字母 (UPPERCASE) 编写
变量名称应该使用连字符 (hyp-hens)、驼峰式命名法 (camelCase) 还是下划线 (under_scores)？
这是程序员经常讨论的问题。答案取决于您问谁：
HTML 和 CSS 中的连字符
HTML5 属性可以以 data- 开头（data-quantity, data-price）。
CSS 在属性名称中使用连字符（font-size）。
连字符可能被误认为是减法操作。JavaScript 名称中不允许使用连字符。
下划线
许多程序员喜欢使用下划线（date_of_birth），尤其是在 SQL 数据库中。
PHP 文档中经常使用下划线。
帕斯卡命名法 (PascalCase)
C 程序员通常更喜欢帕斯卡命名法 (PascalCase)。
驼峰式命名法 (camelCase)
JavaScript 本身、jQuery 和其他 JavaScript 库都使用驼峰式命名法 (camelCase)。
不要以 $ 符号开头命名。这会与许多 JavaScript 库的名称冲突。
在 HTML 中加载 JavaScript
使用简单的语法加载外部脚本（不需要 type 属性）
<script src="myscript.js"></script>
访问 HTML 元素
使用“不整洁”的 HTML 样式可能会导致 JavaScript 错误。
这两个 JavaScript 语句将产生不同的结果：
const obj = getElementById("Demo")
const obj = getElementById("demo")
如果可能，请在 HTML 中使用与 JavaScript 相同的命名约定。
文件扩展名
HTML 文件应使用 .html 扩展名（允许使用 .htm）。
CSS 文件应使用 .css 扩展名。
JavaScript 文件应使用 .js 扩展名。
使用小写文件名
大多数 Web 服务器（Apache、Unix）对文件名区分大小写
london.jpg 无法通过 London.jpg 访问。
其他 Web 服务器（Microsoft、IIS）不区分大小写
london.jpg 可以通过 London.jpg 或 london.jpg 访问。
如果您混合使用大小写，则必须保持极度一致。
如果您从不区分大小写的服务器迁移到区分大小写的服务器，即使是很小的错误也可能导致您的网站崩溃。
为避免这些问题，请始终使用小写文件名（如果可能）。
性能
编码规范不受计算机使用。大多数规则对程序的执行影响很小。
缩进和额外空格在小型脚本中不重要。
对于开发中的代码，应优先考虑可读性。较大的生产脚本应进行最小化处理。
