如何使用 JSdoc 在另一个文件中引用 @class？答案

【问题标题】：How to reference a @class in another file with JSdoc?如何使用 JSdoc 在另一个文件中引用 @class？
【发布时间】：2017-02-28 19:54:19
【问题描述】：

例如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");

我该怎么做？

【问题讨论】：

【解决方案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){}

【讨论】：