jsdoc/no-defaults Correctness

🚧 An auto-fix is planned for this rule, but not implemented at this time.

此规则会报告在 @param 或 @default 的相关部分中使用了默认值。它还可以选择性地报告方括号形式的可选参数的存在。

该规则旨在防止在这些标签上标注默认值，因为这在 ES2015 默认参数中会显得多余。

此规则的错误代码示例：

javascript

/** @param {number} [foo="7"] */
function quux(foo) {}

此规则的正确代码示例：

javascript

/** @param {number} foo */
function quux(foo) {}

/** @param foo */
function quux(foo) {}

配置

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

type: boolean

default: false

如果为 true，则报告 @param 标签中可选参数名称（方括号）的存在。

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-defaults": "error"
  }
}

import { defineConfig } from "oxlint";

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

bash

oxlint --deny jsdoc/no-defaults --jsdoc-plugin

此规则是在 v0.3.2 中添加的。