微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

javascript – jsdoc别名方法名称

使用 jsdoc来记录JavaScript模块时,是否可以设置别名方法名称?例如,我有一个像这样的方法

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

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

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

无论如何,有没有办法在jsdoc语法中正确记录这些?文档将显示为save()的别名或其他内容的东西.

jsdoc中有一个@alias标签,但我不相信它能满足我的要求.

解决方法

如果我的问题正确,那么问题的唯一解决方案就是 @borrows标签.

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐