eslint/no-warning-comments Pedantic

禁止在代码中使用 TODO、FIXME、XXX 之类的警告注释。

开发者经常会添加像 TODO 或 FIXME 这样的注释来标记未完成的工作或需要关注的地方。虽然这些注释在开发过程中很有用，但它们可能表明代码尚未完成，不应直接发布到生产环境。此规则有助于在这些注释进入生产代码之前将其捕获。

以下是此规则的错误代码示例：

javascript

// TODO: 实现此功能
function doSomething() {}

// FIXME: 这里有问题
const x = 1;

/* XXX: 变通处理 */
let y = 2;

以下是此规则的正确代码示例：

javascript

// 这是一条普通注释
function doSomething() {}

// 注意：这里解释了一些内容
const x = 1;

此规则有一个包含以下默认值的选项对象：

json

{
  "terms": ["todo", "fixme", "xxx"],
  "location": "start",
  "decoration": []
}

要匹配的术语数组。匹配不区分大小写。

在哪里检查这些术语：

当 location 为 "start" 时，在注释开头需要忽略的字符数组。可用于忽略 JSDoc 风格注释中常见的注释装饰字符，例如 *。

如何使用

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

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

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "no-warning-comments": "error",
  },
});

bash

oxlint --deny no-warning-comments

此规则在 v1.24.0 中添加。