spaced-line-comment

Обеспечивает согласованное расстояние после // в однострочных комментариях.

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

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

Это правило обеспечивает согласованность пробелов после начала однострочного комментария //.

Это правило принимает два аргумента. Если первый — "always", то // должен быть последан хотя бы одним пробелом. Если "never", то пробел после него не нужен. По умолчанию "always".

Второй аргумент — объект с одним ключом, "exceptions". Значение — массив строковых шаблонов, которые считаются исключениями из правила. Важно отметить, что исключения игнорируются, если первый аргумент "never" . Исключения не могут быть смешанными.

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

// When ["never"]
// This is a comment with a whitespace at the beginning

//When ["always"]
//This is a comment with no whitespace at the beginning
var foo = 5;

// When ["always",{"exceptions":["-","+"]}]
//------++++++++
// Comment block
//------++++++++

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

// When ["always"]
// This is a comment with a whitespace at the beginning
var foo = 5;

//When ["never"]
//This is a comment with no whitespace at the beginning
var foo = 5;

// When ["always",{"exceptions":["-"]}]
//--------------
// Comment block
//--------------

// When ["always",{"exceptions":["-+"]}]
//-+-+-+-+-+-+-+
// Comment block
//-+-+-+-+-+-+-+

Связанные правила

• spaced-comment

Версия

Это правило было введено в ESLint v0.9.0 и удалено в v1.0.0-rc-1.