跳至內容

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 授權發布。