Bagaimana cara melawan banyak variabel yang belum terselesaikan peringatan di Webstorm?

Saya memiliki fungsi yang mengambil data dari server:

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

Webstorm mengatakan bahwa someVar- adalah variabel yang belum terselesaikan. Apa yang bisa saya hilangkan dari peringatan semacam itu?

Saya melihat beberapa opsi:

• Menekan peringatan dalam pengaturan ide;
• Tambahkan file sumber json dengan kolom ( detail );
• Gunakan array-seperti sintaks: data['some_unres_var'];

Juga Webstorm menawarkan saya untuk membuat namespace untuk "data" (menambahkan anotasi seperti /** @namespace data.some_unres_var*/), membuat bidang tersebut, atau mengganti namanya.

Gunakan JSDoc:

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

JSDoc objek. Kemudian anggotanya.

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

• @property untuk variabel lokal (non parameter)
• Diuji di PyCharm. @Nicholi mengonfirmasi bahwa ini berfungsi di Webstorm.
• The {{ member:type }}Andreas sintaks menyarankan mungkin bertentangan dengan Django template.
• Terima kasih atas jawaban Jonny Buchanan yang mengutip wiki @param .

Untuk mendokumentasikan array objek , gunakan []tanda kurung seperti yang disarankan JSDoc :

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

Semua jawaban lain salah untuk kasus umum. Bagaimana jika Anda tidak mendapatkan datasebagai parameter? Anda tidak memiliki JSDoc maka:

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 akan memperingatkan bahwa "result.entries" adalah variabel yang belum terselesaikan (bidang).

Solusi umumnya adalah menambahkan @namespacedeklarasi:

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

menggunakan file js tiruan dengan ekspresi fungsi anonim yang mengembalikan literal json, seperti yang tertulis di http://devnet.jetbrains.com/message/5366907 , mungkin bisa menjadi solusi. Saya juga dapat menyarankan untuk membuat variabel palsu yang akan menampung nilai json ini, dan menggunakan var ini sebagai nilai anotasi @param untuk memberi tahu WebStorm apa tipe sebenarnya. Suka:

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

Lihat juga http://devnet.jetbrains.com/message/5504337#5504337

Penggunaan yang merusak, Luke.

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

Untuk menghapus peringatan di The WebStorm IDE Anda cukup menghapus centang opsi inspeksi untuk:

• Fungsi Javascript yang belum terselesaikan
• Variabel Javascript yang tidak terselesaikan

ps . ini akan menghapus peringatan pada IDE, tapi menurut saya itu bukan ide terbaik, karena kita akan kehilangan salah satu utilitas terbaik di IDE seperti Webstorm, yang dapat memperburuk kualitas kode kita.

Meski begitu, jika ingin mengikuti di menu: File > Settings > Editor > Inspections kita bisa menonaktifkan peringatan Javascript.

Seperti gambar berikut ini: