如何在Webstorm中对抗大量未解决的变量警告

Question

好的,我有一个从ajax获取数据的函数:

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

Webstorm说someVar- 是未解决的变量.我不知道如何处理这么多警告.

我看到几个选项:

• 压制警告;
• 添加带有字段的json源文件(更多详细信息);
• 使用类似数组的语法:( data['some_unres_var']但/** @namespace data.some_unres_var*/警告我不要这样做);
• ???

Webstorm也让我为"数据"创建命名空间(添加注释someVar),创建这样的字段或重命名它.

Answer 1

使用JSDoc:

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

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.
• {{ member:type }}Andreas建议的语法可能与Django模板冲突.
• 感谢Jonny Buchanan的回答引用了@param wiki.

要记录对象数组,请使用[]括号作为JSDoc 建议:

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

Answer 3

所有其他答案对于一般情况都是不正确的.如果你没有data作为参数怎么办？那你没有JSDoc:

function niceApiCall(parameters) {
  const result = await ...  // HTTP call to the API here
  for (const e of result.entries) {
    .. // decorate each entry in the result
  }
  return result;
}

WebStorm将警告"result.entries"是一个未解析的变量(字段).

一般的解决方案是添加一个@namespace声明:

function niceApiCall(parameters) {
  /** @namespace result.entries **/
  const result = await ...  // HTTP call to the API here
  for (const e of result.entries) {
    .. // decorate each entry in the result
  }
  return result;
}

Answer 4

解构使用，卢克。

function getData(data){
    const {member} = data;
    console.log(member);
}

Answer 5

使用带有匿名函数表达式的伪js文件返回json文字,如http://devnet.jetbrains.com/message/5366907所示,可能是一个解决方案.我还建议创建一个保存此json值的伪变量,并将此var用作@param注释的值,以使WebStorm知道实际类型是什么.喜欢:

var jsontext = {"some_unres_var":"val"};
/** @param {jsontext} data
function getData(data){
    console.log(data.some_unres_var);
}

另见http://devnet.jetbrains.com/message/5504337#5504337