跳至主要内容

comment-empty-line-before

要求或禁止在注释之前使用空行。

a {}
              /* ← */
/* comment */ /* ↑ */
/**              ↑
*        This line */

此规则忽略

  • 作为源代码中第一个节点的注释
  • 共享行注释
  • 使用 // 的单行注释（当您使用支持它们的自定义语法时）
  • 选择器和值列表中的注释

该 fix 选项 可以自动修复此规则报告的所有问题。

选项​

string: "always"|"never"

"always"​

注释之前必须始终有空行。

以下模式被视为问题

a {}
/* comment */

以下模式不被视为问题

a {}

/* comment */
a {} /* comment */

"never"​

注释之前绝不能有空行。

以下模式被视为问题

a {}

/* comment */

以下模式不被视为问题

a {}
/* comment */
a {} /* comment */

可选的辅助选项​

except: ["first-nested"]​

反转嵌套且为其父节点的第一个子节点的注释的主选项。

例如，使用 "always"

以下模式被视为问题

a {

  /* comment */
  color: pink;
}

以下模式不被视为问题

a {
  /* comment */
  color: pink;
}

ignore: ["after-comment", "stylelint-commands"]​

"after-comment"​

忽略紧跟在另一个注释之后的注释。

例如，使用 "always"

以下模式不被视为问题

a {
  background: pink;

  /* comment */
  /* comment */
  color: #eee;
}
a {
  background: pink;

  /* comment */

  /* comment */
  color: #eee;
}

"stylelint-commands"​

忽略配置注释，例如 /* stylelint-disable color-no-hex */。

例如，使用 "always"

以下模式被视为问题

a {
  background: pink;
  /* not a configuration comment */
  color: #eee;
}

以下模式不被视为问题

a {
  background: pink;
  /* stylelint-disable color-no-hex */
  color: pink;
}

ignoreComments: ["/regex/", /regex/, "string"]​

忽略与给定正则表达式或字符串匹配的注释。

例如，使用 "always" 并且给定

["/^ignore/", "string-ignore"]

以下模式不被视为问题

:root {
  background: pink;
  /* ignore this comment because of the regex */
  color: pink;
}
:root {
  background: pink;
  /* string-ignore */
  color: pink;
}