1 简介

本文档是 Google 对 JavaScript 编程语言源代码的编码标准的完整定义。当且仅当一个 JavaScript 源文件遵循本文中的规则时，它才被视为符合 Google 风格。

与其他编程风格指南一样，所涉及的问题不仅涵盖格式化的美学问题，还包括其他类型的约定或编码标准。然而，本文档主要关注我们普遍遵循的硬性规则，并避免给出无法明确执行的建议（无论是由人工还是工具执行）。

1.1 术语说明

在本文档中，除非另有说明：

1. 术语注释(comment)始终指实现注释。我们不使用“文档注释”这一说法，而是使用通用术语 “JSDoc” 来指代 /** … */ 中的人类可读文本和机器可读注解。

2. 本风格指南在使用必须(must)、禁止(must not)、应该(should)、不应该(should not)和可以(may)这些短语时，采用 RFC 2119  的术语。术语推荐(prefer)和避免(avoid)分别对应应该和不应该。祈使句和陈述句具有规定性，对应于必须。

其他“术语说明”将在文档中偶尔出现。

1.2 指南说明

本文档中的示例代码是非规范性的。也就是说，虽然示例符合 Google 风格，但它们可能并不是表示代码的唯一风格方式。示例中做出的可选格式化选择不得作为规则强制执行。