Appearance
コメントの最初の文字が大文字になるように強制するか、または大文字にならないように禁止します。
コメントの初期文字の大文字・小文字の不一致は、コードの読みにくさを引き起こす可能性があります。 このルールにより、コードベース全体で一貫したスタイルを維持することができます。
デフォルトの "always" オプションでの 誤り なコード例:
"always"
// 小文字のコメント /* 小文字のブロックコメント */
デフォルトの "always" オプションでの 正しい コード例:
// 大文字のコメント /* 大文字のブロックコメント */ // 123 - アルファベット以外で始まるコメントは無視される
capitalized-comments ルールの設定です。
capitalized-comments
最初の要素は、コメントが "always"(常に)または "never"(決して)大文字で始まるべきかどうかを指定します。2番目の要素は、追加オプションを含む任意のオブジェクトです。
"never"
type: "always" | "never"
"always" | "never"
このオプションは以下のプロパティを持つオブジェクトです。
type: object
object
ブロックコメントに特化した設定オプション。
type: boolean
boolean
true にすると、最初のコメント以降の連続するコメントは無視されます。
true にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。
type: string
string
正規表現パターン。このパターンに一致するコメントは違反と見なされません。
行コメントに特化した設定オプション。
設定ファイルまたは CLI でこのルールを 有効化 するには、次のように使用できます:
{ "rules": { "capitalized-comments": "error" } }
oxlint --deny capitalized-comments
eslint/capitalized-comments スタイル
何をするか
コメントの最初の文字が大文字になるように強制するか、または大文字にならないように禁止します。
なぜこれは問題か
コメントの初期文字の大文字・小文字の不一致は、コードの読みにくさを引き起こす可能性があります。 このルールにより、コードベース全体で一貫したスタイルを維持することができます。
例
デフォルトの
"always"オプションでの 誤り なコード例:デフォルトの
"always"オプションでの 正しい コード例:設定
capitalized-commentsルールの設定です。最初の要素は、コメントが
"always"(常に)または"never"(決して)大文字で始まるべきかどうかを指定します。2番目の要素は、追加オプションを含む任意のオブジェクトです。1つ目のオプション
type:
"always" | "never"2つ目のオプション
このオプションは以下のプロパティを持つオブジェクトです。
block
type:
objectブロックコメントに特化した設定オプション。
block.ignoreConsecutiveComments
type:
booleantrue にすると、最初のコメント以降の連続するコメントは無視されます。
block.ignoreInlineComments
type:
booleantrue にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。
block.ignorePattern
type:
string正規表現パターン。このパターンに一致するコメントは違反と見なされません。
ignoreConsecutiveComments
type:
booleantrue にすると、最初のコメント以降の連続するコメントは無視されます。
ignoreInlineComments
type:
booleantrue にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。
ignorePattern
type:
string正規表現パターン。このパターンに一致するコメントは違反と見なされません。
line
type:
object行コメントに特化した設定オプション。
line.ignoreConsecutiveComments
type:
booleantrue にすると、最初のコメント以降の連続するコメントは無視されます。
line.ignoreInlineComments
type:
booleantrue にすると、コードの途中にあるインラインコメント(行内コメント)は無視されます。
line.ignorePattern
type:
string正規表現パターン。このパターンに一致するコメントは違反と見なされません。
使用方法
設定ファイルまたは CLI でこのルールを 有効化 するには、次のように使用できます:
参照