Oxc
← Back to rules

eslint/capitalized-comments 风格

An auto-fix is available for this rule.

它做了什么 ​

强制或禁止注释首字母大写。

为什么这是个问题？ ​

注释中首字母大小写不一致会使代码更难阅读。 此规则有助于在整个代码库中保持一致的风格。

示例 ​

使用默认的 "always" 选项时，以下为 错误 的代码示例：

js
// lowercase comment
/* lowercase block comment */

使用默认的 "always" 选项时，以下为 正确 的代码示例：

js
// Capitalized comment
/* Capitalized block comment */
// 123 - 以非字母字符开头的注释会被忽略

配置 ​

capitalized-comments 规则的配置。

第一个元素指定注释应 "always"（总是）或 "never"（从不）以大写字母开头。 第二个元素是可选的对象，包含其他选项。

第一个选项 ​

type: "always" | "never"

第二个选项 ​

此选项是一个对象，具有以下属性：

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

参考资料 ​

© 2026 VoidZero Inc. 及 Oxc 贡献者。