line-comment-position

强制执行行注释的位置

行注释可以位于代码上方或旁边。此规则帮助团队保持一致的风格。

// above comment
var foo = "bar";  // beside comment
1
2

规则详情

此规则强制执行行注释的一致位置。块注释不受此规则影响。默认情况下，此规则忽略以以下单词开头的注释：eslint, jshint, jslint, istanbul, global, exported, jscs, falls through。

选项

此规则接受一个参数，它可以是字符串或对象。字符串设置与 position 属性（如下所述）的设置相同。对象选项具有以下属性

position

position 选项有两个设置

• above (默认) 强制行注释仅在代码上方，单独一行。
• beside 强制行注释仅在代码行末尾。

position: above

{ "position": "above" } 选项的正确代码示例

/*eslint line-comment-position: ["error", { "position": "above" }]*/
// valid comment
1 + 1;
1
2
3

{ "position": "above" } 选项的不正确代码示例

/*eslint line-comment-position: ["error", { "position": "above" }]*/
1 + 1; // invalid comment
1
2

position: beside

{ "position": "beside" } 选项的正确代码示例

/*eslint line-comment-position: ["error", { "position": "beside" }]*/
1 + 1; // valid comment
1
2

{ "position": "beside" } 选项的不正确代码示例

/*eslint line-comment-position: ["error", { "position": "beside" }]*/
// invalid comment
1 + 1;
1
2
3

ignorePattern

默认情况下，此规则忽略以以下单词开头的注释：eslint, jshint, jslint, istanbul, global, exported, jscs, falls through。可以提供替代的正则表达式。

ignorePattern 选项的正确代码示例

/*eslint line-comment-position: ["error", { "ignorePattern": "pragma" }]*/
1 + 1; // pragma valid comment
1
2

ignorePattern 选项的不正确代码示例

/*eslint line-comment-position: ["error", { "ignorePattern": "pragma" }]*/
1 + 1; // invalid comment
1
2

applyDefaultIgnorePatterns

即使提供了 ignorePattern，也会应用默认忽略模式。如果您想省略默认模式，请将此选项设置为 false。

{ "applyDefaultIgnorePatterns": false } 选项的正确代码示例

/*eslint line-comment-position: ["error", { "ignorePattern": "pragma", "applyDefaultIgnorePatterns": false }]*/
1 + 1; // pragma valid comment
1
2

{ "applyDefaultIgnorePatterns": false } 选项的不正确代码示例

/*eslint line-comment-position: ["error", { "ignorePattern": "pragma", "applyDefaultIgnorePatterns": false }]*/
1 + 1; // falls through
1
2

已弃用： 对象属性 applyDefaultPatterns 已弃用。请使用属性 applyDefaultIgnorePatterns 代替。

何时不使用

如果您不关心使用不同的行注释样式，则可以关闭此规则。

兼容性

JSCS: validateCommentPosition

版本

此规则在 ESLint v3.5.0 中引入。

资源

• 规则来源
• 测试来源