是否有JavaDoc注释将函数参数定义为回调?

时间:2013-08-08 14:21:27

标签: javascript javadoc phpstorm

是否有一种javadoc方法告诉PHPStorm Javascript函数接受回调作为参数?

/**
 * Calculates the and calls the callback function.
 *
 * @param {string} arg1 The argument.
 * @param {????} callback A function to be called.
 **/
foo: function(arg1,callback)
{
   //...
   callback();
}

1 个答案:

答案 0 :(得分:3)

您可以使用{function}类型,例如

/** 
 * @param {function(number):string} f 
 * @param {number} n 
 * @return {string} 
*/
function foo( f, n ){  return f(n); }

有关详细信息,请参阅Google Closure compiler docs,'类型表达式'部分

JSDoc 3还引入了一个@callback标记(http://usejsdoc.org/tags-callback.html),但它尚不支持(参见this issue