风格指南

代码风格指南

本课程中遵循的编码规则与原则如下：

本章节具有一定的主观性和个人倾向性，您可以根据自己的喜好做出选择。

命名规范

正确命名是让代码更清晰、更易理解的关键。以下是一些通用的命名规则。

1. 使用有意义的名称

最重要的原则是为每个元素（变量、函数、类等）赋予一个能准确反映其作用的名称。例如，存储圆半径的变量应命名为 radius，而不是 num 或 myVal。简洁性仅适用于生命周期较短的元素，如循环计数器。

2. 避免使用保留字

每个 JavaScript 关键字都是保留名称，不应作为变量名使用。以下是 JavaScript 中的保留字列表。

3. 遵循统一的命名约定

某些元素可能需要多个单词来准确描述其用途。本课程采用广泛使用的 驼峰命名法（camelCase），其核心原则如下：

• 所有名称以小写字母开头。
• 若名称由多个单词组成，则除第一个单词外，每个单词的首字母大写。

此外，本课程还遵循以下命名规则：

• 函数和方法名应包含一个动词：如 computeTotal()、findFirstParent()、attackTarget() 等。
• 为了与其他编程语言保持一致，类名以大写字母开头：如 User 而非 user。
• 由于数组可能包含多个元素，因此应使用复数形式或加后缀 List：如 movies 或 movieList，而不应使用 movie。
• 为与普通变量区分开，DOM 元素名称应以 Element（或 Elements 用于数组类型）结尾：如 divElement 而非简单的 div。

与许多其他语言一样，JavaScript 是区分大小写的。例如，myVariable 和 myvariable 是两个不同的变量名，请务必注意！

代码格式化

在 JavaScript 社区中，关于代码格式化的讨论一直存在争议，例如缩进使用空格还是制表符、是否省略分号、字符串使用单引号还是双引号等。

一个简单而高效的解决方案是借助工具自动完成代码格式化工作，从而让您能够专注于更高层次的开发任务。

代码质量

由于 JavaScript 是一种动态类型语言，许多错误直到运行时才会暴露出来，例如函数名拼错、加载不存在的模块等。此外，还有一些问题（如声明变量但从未使用）虽然不影响程序执行结果，却会使代码难以阅读，降低整体质量。

幸运的是，专门的工具——代码检查工具（linter） 可以在编写代码时根据预设规则进行检查，并提示潜在的问题。通过提前发现并修复大量潜在错误，这类工具显著提升了开发效率。