非常教程

Eslint参考手册

规则 | Rules

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中引入。

资源

  • Rule source
  • Documentation source

规则 | Rules相关

1.accessor-pairs
2.array-bracket-newline
3.array-bracket-spacing
4.array-callback-return
5.array-element-newline
6.arrow-body-style
7.arrow-parens
8.arrow-spacing
9.block-scoped-var
10.block-spacing
11.brace-style
12.callback-return
13.camelcase
14.capitalized-comments
15.class-methods-use-this
16.comma-dangle
17.comma-spacing
18.comma-style
19.complexity
20.computed-property-spacing
21.consistent-return
22.consistent-this
23.constructor-super
24.curly
25.default-case
26.dot-location
27.dot-notation
28.eol-last
29.eqeqeq
30.for-direction
31.func-call-spacing
32.func-name-matching
33.func-names
34.func-style
35.function-paren-newline
36.generator-star
37.generator-star-spacing
38.getter-return
39.global-require
40.global-strict
41.guard-for-in
42.handle-callback-err
43.id-blacklist
44.id-length
45.id-match
46.implicit-arrow-linebreak
47.indent
48.indent-legacy
49.init-declarations
50.jsx-quotes
51.key-spacing
52.keyword-spacing
53.linebreak-style
54.lines-around-comment
55.lines-around-directive
56.lines-between-class-members
57.max-depth
58.max-len
59.max-lines
60.max-nested-callbacks
61.max-params
62.max-statements
63.max-statements-per-line
64.multiline-comment-style
65.multiline-ternary
66.new-cap
67.new-parens
68.newline-after-var
69.newline-before-return
70.newline-per-chained-call
71.no-alert
72.no-array-constructor
73.no-arrow-condition
74.no-await-in-loop
75.no-bitwise
76.no-buffer-constructor
77.no-caller
78.no-case-declarations
79.no-catch-shadow
80.no-class-assign
81.no-comma-dangle
82.no-compare-neg-zero
83.no-cond-assign
84.no-confusing-arrow
85.no-console
86.no-const-assign
87.no-constant-condition
88.no-continue
89.no-control-regex
90.no-debugger
91.no-delete-var
92.no-div-regex
93.no-dupe-args
94.no-dupe-class-members
95.no-dupe-keys
96.no-duplicate-case
97.no-duplicate-imports
98.no-else-return
99.no-empty
100.no-empty-character-class
Eslint

ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。

主页 https://eslint.org/
源码 https://github.com/eslint/eslint
发布版本 4.12.0

Eslint目录

1.指南 | Guide
2.规则 | Rules