29. ECMAScript 6 代码风格建议 #

本章列出了一些与 ES6 代码风格相关的建议。

• var 与 let 与 const （详情请参阅变量章节）
  • 优先使用 const。您可以将其用于所有值永不改变的变量。
  • 否则，请使用 let – 用于值会发生变化的变量。
  • 避免使用 var。
• 只要函数可以写成一行，箭头函数就是更优的解决方案。

    readFilePromisified(filename)
    .then(text => console.log(text))
  

  对于多行函数，传统函数也可以很好地工作（需要注意的是 this 不是词法作用域）。

    readFilePromisified(filename)
    .then(function (text) {
        const obj = JSON.parse(text);
        console.log(JSON.stringify(obj, null, 4));
    });
  

  单行函数往往是一次性的。如果不是，那么传统函数的优势在于您可以为其命名，这对于文档和调试非常有用。

• 对象字面量中的属性：一旦对象字面量跨越多行，我就会在最后一项后面添加一个逗号。这种尾随逗号从 ES5 开始就是合法的。它使添加、删除和重新排列条目变得更简单。因此，方法定义始终以 }, 结尾。

    const obj = {
        foo() {
        },
        bar() {
        },
    };
  

• 模块：不要混合使用默认导出和命名导出。您的模块应该专注于单一事物，或者导出多个命名的内容。
  • 例外：具有默认导出的模块，该模块通过命名导出公开了一些用于测试的内部结构。
  • 详情请参阅模块章节。
• 按如下方式格式化生成器：

    // Generator function declaration
    function* genFunc() { ··· }
  
    // Generator function expression
    const genFunc = function* () { ··· };
  
    // Generator method definition in an object literal
    const obj = {
        * generatorMethod() {
            ···
        }
    };
  
    // Generator method definition in a class definition
    class MyClass {
        * generatorMethod() {
            ···
        }
    }
  

  详情请参阅生成器章节。

• 参数处理章节包含函数签名的风格建议。

    // Mark optional parameters via the parameter default value `undefined`
    function foo(optional = undefined) { ··· }
  
    // Mark required parameters via a function that throws an exception
    function foo(required = throwException()) { ··· }
  
    // Enforcing a maximum arity (variant 1 of 2)
    function f(x, y, ...empty) { // max arity: 2
        if (empty.length > 0) {
            throw new Error();
        }
    }
    // Enforcing a maximum arity (variant 2 of 2)
    function f(x, y) { // max arity: 2
        if (arguments.length > 2) {
            throw new Error();
        }
    }
  

• 在可调用实体章节（传统函数、箭头函数、类等）中，有一节提供了建议（何时使用哪一种等）。

此外，“Speaking JavaScript”中的ES5 代码风格建议仍然适用于 ES6。