Jak walczyć z mnóstwem nierozwiązanych zmiennych ostrzegawczych w Webstorm?

Mam funkcję, która pobiera dane z serwera:

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

Webstorm mówi, że someVar- to nierozwiązana zmienna. Czego mogę się pozbyć takich ostrzeżeń?

Widzę kilka opcji:

• Pomiń ostrzeżenia w ustawieniach IDE;
• Dodaj plik źródłowy JSON z polami ( szczegóły );
• Stosować tablice przypominające składni: data['some_unres_var'];

Również Webstorm oferujący mi utworzenie przestrzeni nazw dla „danych” (dodanie adnotacji typu /** @namespace data.some_unres_var*/), utworzenie takiego pola lub zmiana jego nazwy.

Użyj JSDoc:

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

JSDoc obiekt. Potem jego członkowie.

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

• @property dla zmiennych lokalnych (nie parametrów)
• Przetestowano w PyCharm. @Nicholi potwierdza, że ​​działa w Webstorm.
• W {{ member:type }}Andreas składniowe zasugerował mogą być sprzeczne z szablonów Django.
• Dzięki Jonny Buchanana odpowiedzi powołując się na wiki @param .

Aby udokumentować tablice obiektów , użyj []nawiasów, jak sugeruje JSDoc :

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

Wszystkie inne odpowiedzi są niepoprawne w ogólnym przypadku. A jeśli nie otrzymasz dataparametru? Nie masz wtedy 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 ostrzeże, że „result.entries” jest nierozwiązaną zmienną (polem).

Ogólnym rozwiązaniem jest dodanie @namespacedeklaracji:

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;
}

rozwiązaniem może być użycie fikcyjnego pliku js z anonimowym wyrażeniem funkcji zwracającym literał json, zgodnie z zapisem pod adresem http://devnet.jetbrains.com/message/5366907 . Mogę również zasugerować utworzenie fałszywej zmiennej, która będzie przechowywać tę wartość json, i użyć tej zmiennej jako wartości adnotacji @param, aby WebStorm wiedział, jaki jest rzeczywisty typ. Lubić:

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

Zobacz także http://devnet.jetbrains.com/message/5504337#5504337

Destrukturyzujące użycie, Luke.

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

Aby usunąć ostrzeżenia w The WebStorm IDE, możesz po prostu odznaczyć opcje inspekcji dla:

• Nierozwiązana funkcja Javascript
• Nierozpoznana zmienna JavaScript

ps . usunie to ostrzeżenia w IDE, ale nie sądzę, że jest to najlepszy pomysł, ponieważ stracimy jedno z najlepszych narzędzi w IDE, takim jak Webstorm, co może pogorszyć jakość naszego kodu.

Mimo to, jeśli chcesz śledzić w menu: Plik > Ustawienia > Edytor > Inspekcje , możemy wyłączyć ostrzeżenia Javascript

Jak na poniższym obrazku: