尾后逗号

尾后逗号 (有时叫做“终止逗号”)在向 JavaScript 代码添加元素、参数、属性时十分有用。如果你想要添加新的属性,并且上一行已经使用了尾后逗号,你可以仅仅添加新的一行,而不需要修改上一行。这使得版本控制的代码比较(diff)更加清晰,代码编辑过程中遇到的麻烦更少。

JavaScript 一开始就支持数组字面量中的尾后逗号,随后向对象字面量(ECMAScript 5)中添加了尾后逗号。最近(ECMAScript 2017),又将其添加到函数参数中。

但是,JSON 不允许尾后逗号。

字面量中的尾后逗号

数组

JavaScript 忽略数组中的尾后逗号:

var arr = [
  1, 
  2, 
  3, 
];

arr; // [1, 2, 3]
arr.length; // 3

如果使用了多于一个尾后逗号,会产生省略(elision,或者间隙 hole)。 带有间隙的数组叫做稀疏数组(sparse 紧凑数组 dense array 没有省略/间隙)。 例如,当使用 Array.prototype.forEach()Array.prototype.map() 迭代数组时,会跳过数组间隙。

var arr = [1, 2, 3,,,];
arr.length; // 5

对象

从 ECMAScript 5 开始,对象字面值中的尾后逗号也是符合语法的:

var object = { 
  foo: "bar", 
  baz: "qwerty",
  age: 42,
};

函数中的尾后逗号

ECMAScript 2017 支持函数参数中的尾后逗号。

参数定义

下面的两个函数定义都是合法的,并且互相等价。尾后逗号并不影响函数定义,或者其arguments对象的 length属性。

function f(p) {}
function f(p,) {} 

(p) => {};
(p,) => {};

尾后逗号也可用于类或对象的方法定义

class C {
  one(a,) {},
  two(a, b,) {},
}

var obj = {
  one(a,) {},
  two(a, b,) {},
};

函数调用

下面的两个函数调用都是合法的,并且互相等价。

f(p);
f(p,);

Math.max(10, 20);
Math.max(10, 20,);

不合法的尾后逗号

仅仅包含逗号的函数参数定义或者函数调用会抛出 SyntaxError。 而且,当使用剩余参数的时候,并不支持尾后逗号:

function f(,) {} // SyntaxError: missing formal parameter
(,) => {};       // SyntaxError: expected expression, got ','
f(,)             // SyntaxError: expected expression, got ','

function f(...p,) {} // SyntaxError: parameter after rest parameter
(...p,) => {}        // SyntaxError: expected closing parenthesis, got ','

解构中的尾后逗号

在使用解构赋值时,尾后逗号也可以用于左侧:

// 带有尾后逗号的数组解构
[a, b,] = [1, 2];

// 带有尾后逗号的对象解构
var o = {
  p: 42, 
  q: true,
};
var {p, q,} = o;

同样地,在使用剩余参数时,会抛出 SyntaxError

var [a, ...b,] = [1, 2, 3];
// SyntaxError: rest element may not have a trailing comma

JSON 中的尾后逗号

对象中的尾后逗号仅仅在 ECMAScript 5 中引入。由于 JSON 基于 ES5 之前的语法, JSON 中并不允许尾后逗号

下面两行都会抛出 SyntaxError

JSON.parse('[1, 2, 3, 4, ]');
JSON.parse('{"foo" : 1, }');
// SyntaxError JSON.parse: unexpected character 
// at line 1 column 14 of the JSON data

去掉尾后逗号就行了:

JSON.parse('[1, 2, 3, 4 ]');
JSON.parse('{"foo" : 1 }');

规范

规范 状态 备注
ECMAScript 5.1 (ECMA-262) Standard Added object literal trailing commas.
ECMAScript 2015 (6th Edition, ECMA-262) Standard No change.
ECMAScript 2017 (ECMA-262) Standard Added trailing commas to function parameter lists and calls.
ECMAScript Latest Draft (ECMA-262) Draft

浏览器兼容性

Update compatibility data on GitHub
DesktopMobileServer
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung InternetNode.js
Trailing commasChrome Full support 1Edge Full support 12Firefox Full support 1IE Full support 9Opera Full support YesSafari Full support YesWebView Android Full support 1Chrome Android Full support 18Firefox Android Full support 4Opera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support 1.0nodejs Full support Yes
Trailing comma in functionsChrome Full support 58Edge Full support 14Firefox Full support 52IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android Full support 58Firefox Android Full support 52Opera Android No support NoSafari iOS No support NoSamsung Internet Android Full support 7.0nodejs Full support 8.0.0
Trailing comma in object literalsChrome Full support 1Edge Full support 12Firefox Full support 1IE Full support 9Opera Full support YesSafari Full support YesWebView Android Full support 1Chrome Android Full support 18Firefox Android Full support 4Opera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support 1.0nodejs Full support Yes

Legend

Full support  
Full support
No support  
No support

参见