jsdoc别名方法名称

时间:2016-10-28 04:33:27

标签: javascript jsdoc

使用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标记,但我不相信它能满足我的需求。

1 个答案:

答案 0 :(得分:0)

如果我的问题正确无误,那么问题的唯一解决方案就是@borrows标记。