JS-注释重载方法

时间:2018-10-10 21:19:31

标签: javascript methods annotations overloading jsdoc

我喜欢注释我的代码,使用我已编写的代码时,对我的函数的优美注释以及弹出的小信息块的感觉令人赞叹。而且,知道将来的开发人员将能够通过编辑器流畅地处理我的代码是很好的。

由于在Javascript中无法重载方法,因此我想告诉Intellisense(或任何其他阅读注释的软件)我的函数已重载,以及如何使用它们。在可视代码中,编辑器有时会显示有关重载方法的信息:

Overloaded method description provided by Visual Code

我想这意味着有可能这样做,但是找不到任何答案。

我知道JSDoc能够通过将注释粘贴在一起来生成带有重载方法的文档:

/**
 * I am a function 
 * @param {number} param1 i am a parameter
 *//**
 * I am the function overload 
 * @param {string} param1 slightly different param
 */
function something (param1) {}

但是Visual Code对此解释如下:

if only it could work

我对如何使它工作一无所知,我认为这可能会对我的流程有所改善,因此,如果您知道该怎么做,我会很高兴听到的:)

感谢您的关注, 问候

0 个答案:

没有答案