Stylelint 处理 SCSS 文件中双斜杠注释的注意事项

问题现象

在 SCSS 文件中使用双斜杠(//)注释时，如果注释内容中包含 CSS 声明(如 color: var(...))，Stylelint 可能会报出 "Unknown word" 错误。这种问题常见于以下情况：

.radio-button {
  span {
    font-size: 15px;
    
    // 注释中包含CSS声明: color: var(--custom-color)
  }
}

问题原因

这个问题的根本原因是 Stylelint 默认使用标准的 CSS 解析器，而 SCSS 特有的语法(如双斜杠注释)需要专门的 SCSS 解析器来处理。

当注释中包含类似 CSS 声明的文本时，默认解析器会尝试将其解析为有效的 CSS，从而导致语法错误。

解决方案

要正确解析 SCSS 文件，需要在 Stylelint 配置中指定 postcss-scss 作为自定义语法解析器：

{
  "customSyntax": "postcss-scss",
  "plugins": ["stylelint-scss"],
  "rules": {}
}

最佳实践

1. 统一注释风格：在 SCSS 项目中，建议统一使用 /* */ 注释而非 // 注释，除非确实需要行注释

2. 配置继承：可以使用 stylelint-config-recommended-scss 预设配置，它已经包含了正确的 SCSS 解析设置

3. 注释内容规范：避免在注释中直接写入完整的 CSS 声明，可以用自然语言描述

4. 构建工具集成：在 Webpack 等构建工具中，确保相关的 Stylelint 插件也配置了正确的 SCSS 解析器

扩展知识

SCSS 的双斜杠注释在编译后会从生成的 CSS 中移除，而 /* */ 注释则会根据压缩设置决定是否保留。这也是为什么标准 CSS 解析器可能无法正确处理 SCSS 注释的原因之一。

对于大型项目，建议建立统一的样式规范，包括注释书写规范，以避免这类解析问题和提高代码可维护性。