jsdoc/no-blank-blocks 风格

🛠️ An auto-fix is available for this rule for some violations.

报告并可选择性地移除仅包含空白字符的块。

空白 JSDoc 块会增加噪音，却不提供任何文档。

此规则的错误代码示例：

/** */

/**
 *
 */

此规则的正确代码示例：

/** @tag */

/**
 * Text
 */

/**
 * @tag
 */

配置

此规则接受一个包含以下属性的配置对象：

类型：boolean

默认值：false

是否自动移除空白 JSDoc 块。

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/no-blank-blocks": "error"
  }
}

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsdoc"],
  rules: {
    "jsdoc/no-blank-blocks": "error",
  },
});

bash

oxlint --deny jsdoc/no-blank-blocks --jsdoc-plugin

此规则在 v1.78.0 中添加。