Skip to content
← Back to rules

jsdoc/implements-on-classes 正しさ

何をするか

@implements を使用している非コンストラクタ関数に対して問題を報告します。

なぜ悪いのか

コンストラクタ関数は、@class@constructs でマークされている場合やクラスのコンストラクタである場合に限って、@implements を使用すべきです。

このルールに関して 誤り なコードの例:

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

このルールに関して 正しい コードの例:

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

使用方法

設定ファイルまたは CLI でこのルールを 有効化 するには、次のようにします:

json
{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/implements-on-classes": "error"
  }
}
bash
oxlint --deny jsdoc/implements-on-classes --jsdoc-plugin

参照