JSDoc3 & NodeJS链接到模块中的类型

Question

我试图找到如何让JSDoc3从其他模块自动生成到类的链接。我觉得很难用语言来解释，所以让我举几个例子。下面的脚本生成预期的输出：

/**
 * @constructor
 */
var SomeClass = function(){}

/**
 * @param {SomeClass} someParam description
 */
var someFunc = function(someParam){}

也就是说，JSDoc3正确地生成从someFunc的参数列表到SomeClass的类描述的链接。但是，当我将SomeClass放入外部模块时，我似乎不能让JSDoc3生成链接：

/**
 * @file SomeClass.js
 * @module SomeClass
 */

/**
 * @constructor
 */
exports.SomeClass(){}


/**
 * @file main.js
 */
var SomeClass = require('./SomeClass');

/**
 * @param {SomeClass} someParam description
 */
function someFunc(someParam){}

现在，JSDoc3正确地为两个文件生成文档，但是它没有将someFunc的参数类型链接到SomeClass的页面。我尝试用以下内容替换@param {SomeClass}：

• @param {SomeClass.SomeClass}
• @param {SomeClass/SomeClass}
• @param {@link SomeClass}
• @param {@link SomeClass.SomeClass}
• @param {@link SomeClass/SomeClass}

但所有这些都不起作用:在所有情况下，文档仅仅显示了花括号中的文本(即使我使用@link)。

如何让JSDoc3正确地生成到外部模块的链接？

Answer 1

在引用模块时使用module:前缀。如果模块的返回值是类本身，则使用module:SomeClass。如果它是模块的属性，请使用module:SomeClass.SomeClass。如果jsdoc可以找到对现有类文档的引用，就不应该使用@link标记。

Answer 2

使用typeof import

    /**
     * @param {typeof import("puppeteer").Browser} browser
     */

医生来了