Skip to content
← Back to rules

eslint/capitalized-comments スタイル

An auto-fix is available for this rule.

何をするか

コメントの最初の文字が大文字になるように強制するか、または大文字にならないように禁止します。

なぜこれは問題か

コメントの初期文字の大文字・小文字の不一致は、コードの読みにくさを引き起こす可能性があります。 このルールにより、コードベース全体で一貫したスタイルを維持することができます。

デフォルトの "always" オプションでの 誤り なコード例:

js
// 小文字のコメント
/* 小文字のブロックコメント */

デフォルトの "always" オプションでの 正しい コード例:

js
// 大文字のコメント
/* 大文字のブロックコメント */
// 123 - アルファベット以外で始まるコメントは無視される

設定

capitalized-comments ルールの設定です。

最初の要素は、コメントが "always"(常に)または "never"(決して)大文字で始まるべきかどうかを指定します。2番目の要素は、追加オプションを含む任意のオブジェクトです。

1つ目のオプション

type: "always" | "never"

2つ目のオプション

このオプションは以下のプロパティを持つオブジェクトです。

block

type: object

ブロックコメントに特化した設定オプション。

block.ignoreConsecutiveComments

type: boolean

true にすると、最初のコメント以降の連続するコメントは無視されます。

block.ignoreInlineComments

type: boolean

true にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。

block.ignorePattern

type: string

正規表現パターン。このパターンに一致するコメントは違反と見なされません。

ignoreConsecutiveComments

type: boolean

true にすると、最初のコメント以降の連続するコメントは無視されます。

ignoreInlineComments

type: boolean

true にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。

ignorePattern

type: string

正規表現パターン。このパターンに一致するコメントは違反と見なされません。

line

type: object

行コメントに特化した設定オプション。

line.ignoreConsecutiveComments

type: boolean

true にすると、最初のコメント以降の連続するコメントは無視されます。

line.ignoreInlineComments

type: boolean

true にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。

line.ignorePattern

type: string

正規表現パターン。このパターンに一致するコメントは違反と見なされません。

使用方法

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

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

参照