jsdoc 别名方法名称答案

【问题标题】：jsdoc alias method namesjsdoc 别名方法名称
【发布时间】：2018-05-02 09:19:48
【问题描述】：

使用jsdoc 记录您的JavaScript 模块时，是否可以设置别名方法名称？比如我有这样一个方法：

/**
* @name MyModule#save
*/
MyModule.prototype.save = function(...) {
  ...
}

但我的模块有 save() 的别名方法，例如 cache()、put()、set() 等。它们只是方便的方法，因此开发人员可以选择要使用的方法名称。

MyModule.prototype.set = function(...) {
   return this.save(...);
}

无论如何，有没有办法用 jsdoc 语法正确记录这些内容？文档将显示为 Alias of save() 或类似的内容。

jsdoc 中有一个 @alias 标记，但我不相信它符合我的要求。

【问题讨论】：

我也想知道这个。 @alias 从生成的文档中完全删除该函数。对于您的示例，set 将不包括在内，save 不会注意到也可以调用set。如何记录这些信息？
我认为在这种情况下应该在 jsdoc 规范中添加一个@aliasOf 标签。

【解决方案1】：

如果我没有正确回答您的问题，您的问题的唯一解决方案是 @borrows 标签。

【讨论】：