JSDoc3＆NodeJS链接到模块的types

我试图find如何让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的参数types链接到SomeClass的页面。 我试图用以下方法replace@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可以find对现有类文档的引用，则不需要@link标记。