← Back to rules

jsdoc/implements-on-classes 正确性

它的作用

报告任何非构造函数使用 @implements 的问题。

为什么这是不好的？

构造函数应被标记为构造函数，无论是否使用 @class、@constructs 注解，或作为类的构造函数。

示例

此规则的错误代码示例：

/**
 * @implements {SomeClass}
 */
function quux() {}

此规则的正确代码示例：

class Foo {
  /**
   * @implements {SomeClass}
   */
  constructor() {}
}
/**
 * @implements {SomeClass}
 * @class
 */
function quux() {}

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/implements-on-classes": "error"
  }
}

CLI

oxlint --deny jsdoc/implements-on-classes --jsdoc-plugin

参考资料

• 规则源码