no-inline-comments

Запрет встраиваемых комментариев после кода

Некоторые руководства по стилю не допускают комментарии в той же строке, что и код. Код может стать трудночитаемым, если комментарии сразу следуют за кодом в одной строке. С другой стороны, иногда быстрее и понятнее размещать комментарии непосредственно после кода.

Подробное описание правила

Это правило запрещает комментарии в одной строке с кодом.

Примеры неправильного кода для этого правила:

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

var a = 1; // declaring a to 1

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

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

var c = 3; /* A block comment after code */

Примеры правильного кода для этого правила:

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

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

var bar = 5;
//This is a comment below a line of code

Исключение для JSX

Комментарии внутри фигурных скобок в JSX разрешается размещать в той же строке, что и скобки, но только если они не находятся в одной строке с другим кодом, и скобки не заключают в себя фактическое выражение.

Примеры неправильного кода для этого правила:

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

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

var bar = (
    <div>{   // These braces are not just for the comment, so it can't be on the same line
        baz
    }</div>
);

Примеры правильного кода для этого правила:

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

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

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

var quux = (
    <div>{/*
        Multiline
        comment
      */}<h1>Some heading</h1></div>
)

Настройки

ignorePattern

Чтобы сделать это правило игнорирующим определенные комментарии, установите опцию ignorePattern в строковый шаблон, который будет передан конструктору RegExp.

Примеры правильного кода для опции ignorePattern:

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

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

Примеры неправильного кода для опции ignorePattern:

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

var foo = 4; // other thing

Версия

Это правило было введено в ESLint v0.10.0.

Ресурсы

• Исходный код правила
• Исходный код тестов