语法专题—编程风格

作者 | 阮一峰

1、概述

”编程风格“（programming style）指的是编写代码的样式规则。不同的程序员，往往有不同的编程风格。

有人说，编译器的规范叫做”语法规则“（grammar），这是程序员必须遵守的；而编译器忽略的部分，就叫”编程风格“（programming style），这是程序员可以自由选择的。这种说法不完全正确，程序员固然可以自由选择编程风格，但是好的编程风格有助于写出质量更高、错误更少、更易于维护的程序。

所以，编程风格的选择不应该基于个人爱好、熟悉程度、打字量等因素，而要考虑如何尽量使代码清晰易读、减少出错。你选择的，不是你喜欢的风格，而是一种能够清晰表达你的意图的风格。这一点，对于 JavaScript 这种语法自由度很高的语言尤其重要。

必须牢记的一点是，如果你选定了一种“编程风格”，就应该坚持遵守，切忌多种风格混用。如果你加入他人的项目，就应该遵守现有的风格。

2、缩进

行首的空格和 Tab 键，都可以产生代码缩进效果（indent）。

Tab 键可以节省击键次数，但不同的文本编辑器对 Tab 的显示不尽相同，有的显示四个空格，有的显示两个空格，所以有人觉得，空格键可以使得显示效果更统一。

无论你选择哪一种方法，都是可以接受的，要做的就是始终坚持这一种选择。不要一会使用 Tab 键，一会使用空格键。

3、区块

如果循环和判断的代码体只有一行，JavaScript 允许该区块（block）省略大括号。

上面代码的原意可能是下面这样。

但是，实际效果却是下面这样。

因此，建议总是使用大括号表示区块。

另外，区块起首的大括号的位置，有许多不同的写法。最流行的有两种，一种是起首的大括号另起一行。

另一种是起首的大括号跟在关键字的后面。

一般来说，这两种写法都可以接受。但是，JavaScript 要使用后一种，因为 JavaScript 会自动添加句末的分号，导致一些难以察觉的错误。

上面的代码的原意，是要返回一个对象，但实际上返回的是，因为 JavaScript 自动在语句后面添加了分号。为了避免这一类错误，需要写成下面这样。

因此，表示区块起首的大括号，不要另起一行。

4、圆括号

圆括号（parentheses）在 JavaScript 中有两种作用，一种表示函数的调用，另一种表示表达式的组合（grouping）。

建议可以用空格，区分这两种不同的括号。

表示函数调用时，函数名与左括号之间没有空格。

表示函数定义时，函数名与左括号之间没有空格。

其他情况时，前面位置的语法元素与左括号之间，都有一个空格。

按照上面的规则，下面的写法都是不规范的。

上面代码的最后一行是一个匿名函数，是语法关键字，不是函数名，所以与左括号之间应该要有一个空格。

5、行尾的分号

分号表示一条语句的结束。JavaScript 允许省略行尾的分号。事实上，确实有一些开发者行尾从来不写分号。但是，由于下面要讨论的原因，建议还是不要省略这个分号。

5.1、不使用分号的情况

首先，以下三种情况，语法规定本来就不需要在结尾添加分号。

（1）for 和 while 循环

注意，循环是有分号的。

（2）分支语句：if，switch，try

（3）函数的声明语句

注意，函数表达式仍然要使用分号。

以上三种情况，如果使用了分号，并不会出错。因为，解释引擎会把这个分号解释为空语句。

5.2、分号的自动添加

除了上一节的三种情况，所有语句都应该使用分号。但是，如果没有使用分号，大多数情况下，JavaScript 会自动添加。

这种语法特性被称为“分号的自动添加”（Automatic Semicolon Insertion，简称 ASI）。

因此，有人提倡省略句尾的分号。麻烦的是，如果下一行的开始可以与本行的结尾连在一起解释，JavaScript 就不会自动添加分号。

上面代码都会多行放在一起解释，不会每一行自动添加分号。这些例子还是比较容易看出来的，但是下面这个例子就不那么容易看出来了。

下面是更多不会自动添加分号的例子。

只有下一行的开始与本行的结尾，无法放在一起解释，JavaScript 引擎才会自动添加分号。

另外，如果一行的起首是“自增”（）或“自减”（）运算符，则它们的前面会自动添加分号。

上面代码之所以会得到的结果，原因是自增和自减运算符前，自动加上了分号。上面的代码实际上等同于下面的形式。

如果、、和这四个语句后面，直接跟换行符，则会自动添加分号。这意味着，如果语句返回的是一个对象的字面量，起首的大括号一定要写在同一行，否则得不到预期结果。

由于解释引擎自动添加分号的行为难以预测，因此编写代码的时候不应该省略行尾的分号。

不应该省略结尾的分号，还有一个原因。有些 JavaScript 代码压缩器（uglifier）不会自动添加分号，因此遇到没有分号的结尾，就会让代码保持原状，而不是压缩成一行，使得压缩无法得到最优的结果。

另外，不写结尾的分号，可能会导致脚本合并出错。所以，有的代码库在第一行语句开始前，会加上一个分号。

上面这种写法就可以避免与其他脚本合并时，排在前面的脚本最后一行语句没有分号，导致运行出错的问题。

6、全局变量

JavaScript 最大的语法缺点，可能就是全局变量对于任何一个代码块，都是可读可写。这对代码的模块化和重复使用，非常不利。

因此，建议避免使用全局变量。如果不得不使用，可以考虑用大写字母表示变量名，这样更容易看出这是全局变量，比如。

7、变量声明

JavaScript 会自动将变量声明”提升“（hoist）到代码块（block）的头部。

这意味着，变量是代码块之前就存在了。为了避免可能出现的问题，最好把变量声明都放在代码块的头部。

上面这样的写法，就容易看出存在一个全局的循环变量。

另外，所有函数都应该在使用之前定义。函数内部的变量声明，都应该放在函数的头部。

8、with 语句

可以减少代码的书写，但是会造成混淆。

上面的代码，可以有四种运行结果：

这四种结果都可能发生，取决于不同的变量是否有定义。因此，不要使用语句。

9、相等和严格相等

JavaScript 有两个表示相等的运算符：”相等“（）和”严格相等“（）。

相等运算符会自动转换变量类型，造成很多意想不到的情况。

因此，建议不要使用相等运算符（），只使用严格相等运算符（）。

10、语句的合并

有些程序员追求简洁，喜欢合并不同目的的语句。比如，原来的语句是

他喜欢写成下面这样。

虽然语句少了一行，但是可读性大打折扣，而且会造成误读，让别人误解这行代码的意思是下面这样。

建议不要将不同目的的语句，合并成一行。

11、自增和自减运算符

自增（）和自减（）运算符，放在变量的前面或后面，返回的值不一样，很容易发生错误。事实上，所有的运算符都可以用代替。

改用，代码变得更清晰了。

建议自增（）和自减（）运算符尽量使用和代替。

12、switch...case 结构

结构要求，在每一个的最后一行必须是语句，否则会接着运行下一个。这样不仅容易忘记，还会造成代码的冗长。

而且，不使用大括号，不利于代码形式的统一。此外，这种结构类似于语句，容易造成程序流程的混乱，使得代码结构混乱不堪，不符合面向对象编程的原则。

上面的代码建议改写成对象结构。

因此，建议结构可以用对象结构代替。