← Back to rules

eslint/no-inline-comments 厳格

何をするか

コードと同じ行にコメントを許可しない。

なぜ悪いのか

コードの行の末尾にコメントを置くと、コードの読みにくさが増す。垂直方向にスキャンする際に簡単に見落とされやすく、行の長さも長くなる。コメントを別行に移動させることで、コメントの存在感が高まり、行の長さも短縮される。

例

このルールに対して 不正な コードの例:

var a = 1; // 行内コメント
var b = 2; /* 他の行内コメント */

このルールに対して 正しい コードの例:

// 別行に配置されたコメント
var a = 1;

/* 別行に配置されたブロックコメント */
var b = 2;

設定

このルールは以下のプロパティを持つ設定オブジェクトを受け入れます。

ignorePattern

type: string

特定の行内コメントを無視するための正規表現パターン。

このパターンに一致するコメントは報告されません。

設定例:

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

使用方法

このルールを有効にするには、設定ファイルまたは CLI を使用できます。

設定ファイル (.oxlintrc.json)

{
  "rules": {
    "no-inline-comments": "error"
  }
}

CLI

oxlint --deny no-inline-comments

参照

• ルールのソース