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

【问题标题】：How to document a Module that Exports an Instance of a Class with JSDoc如何使用 JSDoc 记录导出类实例的模块
【发布时间】：2018-03-06 05:21:04
【问题描述】：

我正在开发一个 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 方法的干净方法。

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

【问题讨论】：

标签： javascript documentation jsdoc

【解决方案1】：

玩了一会儿后，我发现@borrows 标签似乎可以按我的意愿工作。

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

【讨论】：