跳至内容

jsdoc/implements-on-classes 正确性

作用

报告使用 @implements 的所有非构造函数问题。

为什么不对?

构造函数应标记为 @class@constructs 或为 ES6 类构造函数。

示例

此规则的不正确代码示例

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

此规则的正确代码示例

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

参考

根据 MIT 许可证发布。