如何应对 WebStorm 中大量未解决的变量警告？

Question

我有一个从服务器获取数据的函数：

 function getData(data){
    console.log(data.someVar);
}

WebStorm 说 someVar 是一个未解析的变量。我怎样才能摆脱这样的警告？

我看到几个选项：

• 抑制 IDE 设置中的警告；
• 添加带有字段的 JSON 源文件（ 详细信息）；
• 使用类似数组的语法： data['some_unres_var'] ；

此外，WebStorm 让我为“数据”创建命名空间（添加像 /** @namespace data.some_unres_var*/ 这样的注释），创建这样的字段，或重命名它。

原文由 Sergei Panfilov 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

使用 JSDoc ：

 /**
 * @param {{some_unres_var:string}} data
 */
function getData(data){
    console.log(data.some_unres_var);
}

原文由 Andreas Berheim Brudin 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

JSDoc 对象。然后是它的成员。

 /**
 * @param data          Information about the object.
 * @param data.member   Information about the object's members.
 */
function getData(data){
    console.log(data.member);
}

• @property 用于局部变量（非参数）。
• 在 PyCharm 中测试。 @Nicholi 确认它在 WebStorm 中有效。
• Andreas 建议的 {{ member:type }} 语法可能与 Django 模板冲突。
• 感谢 Jonny Buchanan 引用 @param wiki 的 回答。

要记录 对象数组， 请按照 JSDoc 的 建议 使用 [] 括号：

 /**
 * @param data
 * @param data.array_member[].foo
 */

原文由 Bob Stein 发布，翻译遵循 CC BY-SA 4.0 许可协议