Skip to content
← Back to rules

eslint/no-inline-comments 严谨

它的作用

禁止在代码行的同一行上出现注释。

为什么这是不好的?

将注释放在代码行的末尾会增加代码的阅读难度。
在垂直扫描时,这些注释很容易被忽略,同时会使行长度变长。
将注释移至独立的行上,可以让它们更加突出,并减少行长度。

示例

此规则的错误示例:

js
var a = 1; // 行内注释
var b = 2; /* 另一个行内注释 */

此规则的正确示例:

js
// 注释在单独的行上
var a = 1;

/* 块注释在单独的行上 */
var b = 2;

配置

该规则接受一个包含以下属性的配置对象:

ignorePattern

type: string

用于忽略特定行内注释的正则表达式模式。

匹配此模式的注释将不会被报告。

示例配置:

json
{
  "no-inline-comments": ["error", { "ignorePattern": "webpackChunkName" }]
}

如何使用

要通过配置文件或 CLI 启用此规则,可以使用:

json
{
  "rules": {
    "no-inline-comments": "error"
  }
}
bash
oxlint --deny no-inline-comments

参考资料