javascript - 如何描述传递的匿名函数的参数？

Question

我想用 JSDoc 描述 curVal？

我在 arrays.every() 之前和匿名回调中尝试了 @param，但它对 PhpStorm 的解析没有帮助方法。

/**
 * @param {Array} curVal
 */
arrays.every(function (curVal) {
    /**
     * @param {Array} curVal
     */     
    curVal.???
});

我需要它是为了方便，我只是想在 IDE 的自动完成 Array.prototype 方法中轻松访问对象 curVal

Answer 1

我不知道 PhpStorm 有多聪明(the docs 说它识别闭包编译器 tags and type annotations)，但我可以想到两种可能的解决方案。

首先是直接告诉它函数参数的类型:

arrays.every(/** @param {Array} curVal */ function (curVal) {
  // ...
});

或者(Closure Compiler 内联样式):

arrays.every(function (/** Array */ curVal) {
  // ...
});

其次，只有当 PhpStorm 足够聪明知道 Array.prototype.every 的回调如何获取其参数时，这才会起作用，以确保它知道 arrays 是一个数组数组:

/** @type {Array.<Array>} */
var arrays = getArrays();

或者:

var arrays = /** Array.<Array> */ getArrays();