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

Question

例如我的类.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:

Warning: By using the @name tag, you are telling JSDoc to ignore the surrounding code and treat your documentation comment in isolation. In many cases, it is best to use the @alias tag instead, which changes a symbol's name in the documentation but preserves other information about the symbol.

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