ESLint 注释的正确姿势，告别被 eslint-no-warning-comments 报错
前言
当我们在开发前端应用的时候，经常会遇到代码规范的问题。ESLint 作为一个静态代码检查工具，可以有效地帮助开发者检查代码的规范性。但是，有时候我们会因为某些原因需要在代码中添加一些注释，而这些注释可能会被 ESLint 检测到，导致出现报错。今天我将为大家介绍 ESLint 注释的正确姿势，让大家告别被 eslint-no-warning-comments 报错的困扰。
什么是 eslint-no-warning-comments 报错？
在介绍 ESLint 注释的正确姿势之前，我们需要了解一下什么是 eslint-no-warning-comments 报错。
eslint-no-warning-comments 报错是一种常见的警告信息，当我们在代码中添加某些注释时，如果这些注释包含了特定的关键字，如 “FIXME”、“TODO”、“HACK” 等，那么 ESLint 会认为这些注释是有可能存在问题的代码，并给出警告信息。该警告信息的意思是：注释中使用了特殊的关键字，这说明代码有可能存在问题，需要开发者进一步检查。
在 ESLint 官方文档中，对 eslint-no-warning-comments 报错的默认配置为 true，即默认开启。因此，当我们使用这个默认配置时，如果在代码中添加了上述的特定关键字注释，那么就可能会遇到 eslint-no-warning-comments 报错。
正确的 ESLint 注释方式
了解了 eslint-no-warning-comments 报错后，我们需要知道正确的 ESLint 注释方式，以避免该警告信息的出现。下面给出几种常见的示例注释代码：
示例 1： // eslint-disable-next-line no-alert
window.alert('This is an alert!');运行以上代码时，ESLint 将不会对 window.alert('This is an alert!'); 进行警告。
示例 2：
/* eslint-disable no-console */
console.log('This is a message for debugging');
/* eslint-enable no-console */运行以上代码时，ESLint 将不会对 console.log('This is a message for debugging'); 进行警告。
示例 3： // eslint-disable-line no-console
console.log('This is a message for debugging');运行以上代码时，ESLint 将不会对 console.log('This is a message for debugging'); 进行警告。
使用以上三种注释方式，都可以有效地避免 eslint-no-warning-comments 报错的出现。
需要注意的是，使用以上注释方式时，注释中的特定关键字依然存在，但是由于我们已经通过注释的方式告诉了 ESLint 这些代码是没有问题的，因此 ESLint 不会再对此进行检查。
总结
在使用 ESLint 进行前端开发时，代码规范的问题是一个需要重视的问题。通过掌握正确的 ESLint 注释方式，我们可以避免在代码中添加一些注释时出现 eslint-no-warning-comments 报错的问题，从而提高代码的质量和规范性。希望本文对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65b4c3c2add4f0e0ffd9fd2e