Eslint
规则 | Rules

line-comment-position

强制行注释的位置(line-comment-position)

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

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

规则细节

此规则强制行注释的一致性。阻止评论不受此规则的影响。默认情况下,这个规则忽略先从下面的话评论:eslintjshintjslintistanbulglobalexportedjscsfalls through

选项

这条规则带有一个参数,它可以是一个字符串或一个对象。字符串设置与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

默认情况下,这个规则忽略先从下面的话评论:eslintjshintjslintistanbulglobalexportedjscsfalls 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

弃用:对象属性applyDefauapplyDefaultPatterns已弃用。请改用该属性ltIgnorePatterns

何时不使用它

如果您不关心使用不同的线条评论样式,那么您可以关闭此规则。

兼容性

JSCS: validateCommentPosition

版本

该规则在 ESLint 3.5.0中引入。

资源