使用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标签.