[Javascript] 编程实践之1: Google的Javascript代码风格1：简介

Google的Javascript风格指南

• 内容目录
• • 1 简介
  • • 1.1 术语注意事项
    • 1.2 规范注意事项

本帖为对Google Javascript Style Guide的中文翻译，目的是为国内的Javascript开发者提供风格一致性方面的指南。由于译者水平有限，错误和疏漏在所难免。对于中文翻译不太容易理解的地方，建议读者直接阅读原文对应部分。欢迎大家在留言中批评指正。

内容目录

1 简介

该风格指南描述了Google针对Javascript编程语言所定义的编码规范的完整定义。当且仅当一个Javascript源文件的编码符合如下规范时，才称之为符合Google的编码风格。

和针对其它语言的风格规范一样，本规范所描述的内容不仅包括出于美观考虑的格式规范，而且包括代码标准的一些约定。但是，本文档将主要聚焦于通用规则，而避免提供无法明确执行的建议（无论是通过人工方式还是通过工具）。

1.1 术语注意事项

在本风格指南中，除非另有说明：

1. 术语注释始终指实施注释。我们不使用短语文档注释，而是在内，采用通用术语“JSDoc”，使其同时满足人类可读以及机器可读。
2. 本风格指南在使用短语“必须”，“不能”，“应该”，“不应该”和“可能”时使用RFC2119术语。术语“优选”和“避免”分别对应于应该和不应该。祈使性和陈述性陈述是规定性的，与必须陈述相对应。

其它术语注释会有时出现在整个文档中。

1.2 规范注意事项

本文档中的示例代码是非规范性的。也就是说，尽管这些示例采用的是Google样式，但它们可能并不能代表表示代码的唯一时尚方式。在示例中作出的可选格式选择不得作为规则执行。