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
 */

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

1 个答案: