如何使用JSDoc记录导出类实例的模块

Question

我正在开发一个Javascript项目，其中默认导出（即，当您需要模块时获得的内容）是扩展类的类的实例。

例如：

/**
 * @module my-module-name
 */

/**
 * Private so documentation doesn't mention DefaultRouter
 * @private
 */
class DefaultRouter extends Router {
    /**
     * Extra method docs
     */
    extreMethod() {}
}
export default new DefaultRouter();

这个（理想情况下）的文档将包括Router类（开发人员可以使用）并显示模块的API表面，包括扩展类Router以及extraMethod的文档。

我可以通过使用@alias module:my-module-name.extraMethod获得extraMethod文档，但我找不到一个干净的方式来公开Router方法。

我怎样才能以更简单的方式做到这一点，例如有一些@标签？

Answer 1

玩了一下之后，我发现@borrows标签看起来像我想要的那样。

/**
 * @module my-module-name
 * @borrows module:my-module-name.Router#methodName as methodName
 */