newline-before-return

要求在 return 语句前有一个空行

关于空行是否应在 JavaScript 中 return 语句之前，没有硬性规定。但是，清楚地标明函数返回的位置可以大大提高代码的可读性和清晰度。例如

function foo(bar) {
  var baz = 'baz';
  if (!bar) {
    bar = baz;
    return bar;
  }
  return bar;
}
1
2
3
4
5
6
7
8

添加换行符可以明显地将 return 语句与前几行分隔开来，从而清楚地表明函数在哪里退出以及它返回什么值

function foo(bar) {
  var baz = 'baz';

  if (!bar) {
    bar = baz;

    return bar;
  }

  return bar;
}
1
2
3
4
5
6
7
8
9
10
11

规则详情

此规则要求在 return 语句前有一个空行以提高代码清晰度，除非 return 单独位于语句组内（例如 if 语句）。在后一种情况下，return 语句不需要被描绘，因为它本身是单独的。注释将被忽略，并且不计为空行。

此规则的 错误 代码示例

/*eslint newline-before-return: "error"*/

function foo1(bar) {
    if (!bar) {
        return;
    }
    return bar;
}

function foo2(bar) {
    if (!bar) {
        return;
    }
    /* multi-line
    comment */
    return bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

此规则的 正确 代码示例

/*eslint newline-before-return: "error"*/

function foo1() {
    return;
}

function foo2() {

    return;
}

function foo3(bar) {
    if (!bar) return;
}

function foo4(bar) {
    if (!bar) { return };
}

function foo5(bar) {
    if (!bar) {
        return;
    }
}

function foo6(bar) {
    if (!bar) {
        return;
    }

    return bar;
}

function foo7(bar) {
    if (!bar) {

        return;
    }
}

function foo8() {

    // comment
    return;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

何时不使用

如果您对 return 语句之前的空格没有任何严格的约定，则可以安全地禁用此规则。

相关规则

• newline-after-var

版本

此规则在 ESLint v2.3.0 中引入。

资源

• 规则源
• 测试源