line-comment-position

强制行注释的位置

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

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

规则详情

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

选项

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

position

position 选项有两个设置：

• above（默认）仅在代码上方强制行注释，在它自己的行中。
• beside 仅在代码行末尾强制行注释。

position: above

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

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

{ "position": "above" } 选项的错误代码示例：

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

position: beside

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

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

{ "position": "beside" } 选项的错误代码示例：

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

ignorePattern

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

ignorePattern 选项的正确代码示例：

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

ignorePattern 选项的错误代码示例：

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

applyDefaultIgnorePatterns

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

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

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

{ "applyDefaultIgnorePatterns": false } 选项的错误代码示例：

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

**已弃用：**对象属性 applyDefaultPatterns 已弃用。请改用属性 applyDefaultIgnorePatterns。

何时不使用

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

兼容性

JSCS：validateCommentPosition