no-inline-comments

禁止在代码后添加行内注释

❄️

此规则目前处于冻结状态，不接受功能请求。

一些风格指南不允许在与代码相同的行上添加注释。如果注释紧跟在同一行代码之后，代码可能会变得难以阅读。另一方面，有时将注释紧跟在代码之后会更快更明显。

规则详情

此规则禁止在与代码相同的行上添加注释。

此规则的错误代码示例

/*eslint no-inline-comments: "error"*/

const a = 1; // declaring a to 1

function getRandomNumber(){
    return 4; // chosen by fair dice roll.
              // guaranteed to be random.
}

/* A block comment before code */ const b = 2;

const c = 3; /* A block comment after code */
1
2
3
4
5
6
7
8
9
10
11
12

此规则的正确代码示例

在 Playground 中打开

/*eslint no-inline-comments: "error"*/

// This is a comment above a line of code
const foo = 5;

const bar = 5;
//This is a comment below a line of code
1
2
3
4
5
6
7

JSX 异常

JSX 中花括号内的注释允许与花括号在同一行，但前提是它们不与同一行的其他代码在同一行，并且花括号不包含实际的表达式。

此规则的错误代码示例

在 Playground 中打开

/*eslint no-inline-comments: "error"*/

const foo = <div>{ /* On the same line with other code */ }<h1>Some heading</h1></div>;

const bar = (
    <div>
    {   // These braces are not just for the comment, so it can't be on the same line
        baz
    }
    </div>
);
1
2
3
4
5
6
7
8
9
10
11

此规则的正确代码示例

在 Playground 中打开

/*eslint no-inline-comments: "error"*/

const foo = (
    <div>
      {/* These braces are just for this comment and there is nothing else on this line */}
      <h1>Some heading</h1>
    </div>
)

const bar = (
    <div>
    {
        // There is nothing else on this line
        baz
    }
    </div>
);

const quux = (
    <div>
      {/*
        Multiline
        comment
      */}
      <h1>Some heading</h1>
    </div>
)
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

选项

ignorePattern

要使此规则忽略特定的注释，请将 ignorePattern 选项设置为一个字符串模式，该模式将传递给 RegExp 构造函数。

ignorePattern 选项的正确代码示例

在 Playground 中打开

/*eslint no-inline-comments: ["error", { "ignorePattern": "webpackChunkName:\\s.+" }]*/

import(/* webpackChunkName: "my-chunk-name" */ './locale/en');
1
2
3

ignorePattern 选项的错误代码示例

在 Playground 中打开

/*eslint no-inline-comments: ["error", { "ignorePattern": "something" }] */

const foo = 4; // other thing
1
2
3

版本

此规则在 ESLint v0.10.0 中引入。

资源

编辑此页