javascript - @memberof 用于共享类方法？

Question

在我的库中，我使用仅在一处定义的相同方法query 来扩展类型Database 和Transaction。

如果我尝试使用@memberof Database和@memberof Transaction，后者会覆盖前者。

在jsdoc中指示函数代表两个不同类中的方法的正确方法是什么？

Answer 1

我会这样做:

/**
 * @interface Interface
 * ...
 */

 /**
  * @function query
  * @memberof Interface
  * ...
  */

/**
 * @class Database
 * @implements Interface
 * ...
 */

/**
 * @class Transaction
 * @implements Interface
 * ...
 */

只要没有其他人想要实现 Interface，代码中任何地方都没有定义 Interface 并不一定重要。如果您认为可能，那么创建并扩展一个基类(使用原型(prototype)继承或 ES6 类)，并相应地记录。