---
url: /docs/guide/usage/linter/rules/eslint/no-warning-comments.md
---

### 它的作用

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

### 为什么这不好？

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

### 示例

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

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

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

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

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

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

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

## 配置

此规则接受一个包含以下属性的配置对象：

### decoration

类型: `string[]`

默认值: `[]`

一个字符数组，用于在 `location` 为 `"start"` 时忽略注释开头的字符。

适用于忽略 JSDoc 风格注释中常见的注释装饰符，例如 `*`。

### location

类型: `"start" | "anywhere"`

默认值: `"start"`

检查术语的位置。

#### `"start"`

术语必须出现在注释的开头，位于所有装饰符之后。

#### `"anywhere"`

术语可以出现在注释中的任意位置。

### terms

类型: `string[]`

默认值: `["todo", "fixme", "xxx"]`

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

## 使用方法

## 版本

此规则在 v1.24.0 中添加。

## 参考资料