如何用JSdoc引用另一个文件中的@class？

Question

E.g。 MyClass.js

/**
 * @class
 * @name module:Bar
 * @param {number} a1
 * @param {string} a2
 */
function Bar(a1, a2){}

而且，在另一个文件中：

/** @type module:Bar.constructor */ // made up syntax
var Bar = require("./MyClass.js");

重新定义@class有效，但不方便：

/**
 * @class
 * @name module:Bar
 * @param {number} a1
 * @param {string} a2
 */
var Bar = require("./MyClass.js");

我该怎么做？

Answer 1

仅凭课名就足够了。

/**
 * @type module:Bar
 */
var Bar = require("./MyClass.js");

您应该使用@alias代替@name：

  

警告：通过使用@name标记，您告诉JSDoc忽略   周围的代码并单独处理您的文档注释。在   很多情况下，最好使用@alias标签代替，这会改变一个   文档中的符号名称，但保留其他信息   关于符号。

/**
 * @class
 * @alias module:Bar
 * @param {number} a1
 * @param {string} a2
 */
function Bar(a1, a2){}