multiline-comment-style

对多行注释强制使用特定样式

一些该规则报告的问题可以通过 --fix 命令行选项 自动修复

许多样式指南要求跨多行注释的特定样式。例如，一些样式指南更喜欢对多行注释使用单个块注释，而其他样式指南更喜欢连续行注释。

规则详情

此规则旨在为多行注释强制执行特定样式。

选项

此规则有一个字符串选项，它可以具有以下值之一：

• "starred-block"（默认）：不允许连续的行注释以支持块注释。此外，要求块注释在每行之前有一个对齐的 * 字符。
• "bare-block"：不允许连续的行注释支持块注释，并且不允许块注释在每行之前有一个 "*" 字符。
• "separate-lines"：禁止块注释以支持连续的行注释

该规则始终忽略指令注释，例如 /* eslint-disable */。此外，除非模式为 "starred-block"，否则该规则将忽略 JSDoc 注释。

此规则使用默认 "starred-block" 选项的错误代码示例：

/* eslint multiline-comment-style: ["error", "starred-block"] */

// this line
// calls foo()
foo();

/* this line
calls foo() */
foo();

/* this comment
 * is missing a newline after /*
 */

/*
 * this comment
 * is missing a newline at the end */

/*
* the star in this line should have a space before it
 */

/*
 * the star on the following line should have a space before it
*/

此规则使用默认 "starred-block" 选项的正确代码示例：

/* eslint multiline-comment-style: ["error", "starred-block"] */

/*
 * this line
 * calls foo()
 */
foo();

// single-line comment

此规则使用 "bare-block" 选项的错误代码示例：

/* eslint multiline-comment-style: ["error", "bare-block"] */

// this line
// calls foo()
foo();

/*
 * this line
 * calls foo()
 */
foo();

此规则使用 "bare-block" 选项的正确代码示例：

/* eslint multiline-comment-style: ["error", "bare-block"] */

/* this line
   calls foo() */
foo();

此规则使用 "separate-lines" 选项的错误代码示例：

/* eslint multiline-comment-style: ["error", "separate-lines"] */

/* This line
calls foo() */
foo();

/*
 * This line
 * calls foo()
 */
foo();

此规则使用 "separate-lines" 选项的正确代码示例：

/* eslint multiline-comment-style: ["error", "separate-lines"] */

// This line
// calls foo()
foo();

何时不使用

如果您不想为多行注释强制执行特定样式，则可以禁用该规则。