我使用JSDoc进行参数文档编制。
如何记录many_prompts
的参数类型是很清楚的,但是记录它返回的函数的正确方法是什么呢?
/**
* @param {Number} - number of times to prompt
* @return {Function(prompt{Number})} - the returned function
*/
function many_prompts(count) {
return function(prompt) {
for(var i=0; i < count; i++) alert(prompt);
}
}
//Example of use:
var y =many_prompts(3);
y('Hello World');
4条答案
按热度按时间hec6srdp1#
您可以记录内部函数,然后像这样引用它
zvokhttg2#
这似乎对我有用。
qxgroojn3#
我喜欢的方式:
x3naxklr4#
这是我的解决方案,我没有在第一个函数中描述一个返回值,同时也记录了内部函数,这导致了从内部函数中获取文档。
然后在vscode中显示,如下图所示...
对于外部函数:
对于内部函数:
您还可以在分配函数时添加附加说明,以描述差异