如何记录重载函数?

时间:2018-06-18 10:34:00

标签: javascript intellij-idea jsdoc

我有2个函数(实际上是1个检查arg类型的函数):

moveTo(x, y, opts)
moveTo(point, opts)

opts是一个具有长文档的对象

 /*
 * .... 
 * @param {object} [opts] An object containing additional options
 * @param {number} [opts.opt1] desc1
 * @param {boolean} [opts.opt2] desc2
 */

如何使用jsdoc正确记录此功能?

我知道我可以使用技巧并将所有opts定义复制到y参数:

* @param {number|object} [y] ...

但那真的很难看。还有另一种方式吗?

0 个答案:

没有答案