WebStorm 中带有 JSDoc 的选项参数的属性：“未解析的变量”

Question

我的代码中有一个带有 jsdoc 注释的函数，类似于以下代码：

/**
 * Foo function
 * @param {Object} [options]
 * @param {String} [options.foo]
 */
var foo = function (options) {
    if (!options) options = {};
    var foo = options.foo || 'foo';
    // ...
};

我的 IDE WebStorm 将 options.foo 标记为“未解析的变量”。如果我删除 jsdoc 注释，警告就会消失。如何以 WebStorm 获取提示且不再显示此警告的方式记录此功能？

我尝试过的事情：

• 删除@param {String} [options.foo]
• @param {?String} [options.foo]
• @param {String} options.foo
• if (!options) options = {foo: 'bar'};
• 最后两个合并。

这是一个错误还是我错过了什么？ WebStorm 似乎确实理解了options.foo 参数定义，因为if (!options) options = {foo: 42}; 引发了一个警告，即分配的类型不是字符串。

我正在使用 WebStorm 7.0。

Answer 1

Webstorm 的文档链接到 jsdoc 3。使用 jsdoc 3，我会像这样记录您的对象：

@param {{foo: string}} options

您尝试执行此操作的方式暗示了像 function (options, options.foo) 这样的函数签名。

here 提供有关如何记录类型的信息。