Disallow Warning Comments (no-warning-comments)

禁用警告注释 (no-warning-comments)

Developers often add comments to code which is not complete or needs review. Most likely you want to fix or review the code, and then remove the comment, before you consider the code to be production ready.

开发者经常给代码添加注释,标明哪些没有完成或需要审查。在你认为代码可以发布之前,你很有可能想修复或审查代码,然后删除注释。

// TODO: do something
// FIXME: this is not a good idea

Rule Details

This rule reports comments that include any of the predefined terms specified in its configuration.

该规则报告含有配置中预定义的项的注释。

Options

This rule has an options object literal:

该规则有一个对象选项:

Example of incorrect code for the default { "terms": ["todo", "fixme", "xxx"], "location": "start" } options:

默认选项 { "terms": ["todo", "fixme", "xxx"], "location": "start" }错误 代码示例:

/*eslint no-warning-comments: "error"*/

function callback(err, results) {
  if (err) {
    console.error(err);
    return;
  }
  // TODO
}

Example of correct code for the default { "terms": ["todo", "fixme", "xxx"], "location": "start" } options:

默认选项 { "terms": ["todo", "fixme", "xxx"], "location": "start" }正确 代码示例:

/*eslint no-warning-comments: "error"*/

function callback(err, results) {
  if (err) {
    console.error(err);
    return;
  }
  // NOT READY FOR PRIME TIME
  // but too bad, it is not a predefined warning term
}

terms and location

Examples of incorrect code for the { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" } options:

选项 { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }错误 代码示例:

/*eslint no-warning-comments: ["error", { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }]*/

// TODO: this
// todo: this too
// Even this: TODO
/* /*
 * The same goes for this TODO comment
 * Or a fixme
 * as well as any other term
 */

Examples of correct code for the { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" } options:

选项 { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }正确 代码示例:

/*eslint no-warning-comments: ["error", { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }]*/

// This is to do
// even not any other    term
// any other terminal
/*
 * The same goes for block comments
 * with any other interesting term
 * or fix me this
 */

When Not To Use It

Version

This rule was introduced in ESLint 0.4.4.

该规则在 ESLint 0.4.4 中被引入。

Resources


+