จะต่อสู้กับตัวแปรที่ไม่ได้รับการแก้ไขจำนวนมากที่เตือนใน Webstorm ได้อย่างไร

ฉันมีฟังก์ชันที่รับข้อมูลจากเซิร์ฟเวอร์:

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

Webstorm กล่าวว่าsomeVar- เป็นตัวแปรที่ไม่ได้รับการแก้ไข ฉันจะกำจัดคำเตือนดังกล่าวได้อย่างไร?

ฉันเห็นหลายตัวเลือก:

• ระงับคำเตือนในการตั้งค่า ide;
• เพิ่มไฟล์ซอร์ส json พร้อมฟิลด์ ( รายละเอียด );
• ใช้ไวยากรณ์เหมือนอาร์เรย์: data['some_unres_var'];

นอกจากนี้ Webstorm ยังเสนอให้ฉันสร้างเนมสเปซสำหรับ "ข้อมูล" (เพิ่มคำอธิบายประกอบเช่น/** @namespace data.some_unres_var*/) สร้างฟิลด์ดังกล่าวหรือเปลี่ยนชื่อ

ใช้ JSDoc:

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

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
• ขอขอบคุณที่จอนนี่บูคานันของคำตอบที่อ้างวิกิพีเดีย @param

ในการจัดทำเอกสารอาร์เรย์ของวัตถุให้ใช้[]วงเล็บตามที่ JSDoc แนะนำ :

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

คำตอบอื่น ๆ ทั้งหมดไม่ถูกต้องสำหรับกรณีทั่วไป จะเกิดอะไรขึ้นถ้าคุณไม่ได้รับ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;
}

การใช้ไฟล์ 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

ใช้ทำลายล้างลุค

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

หากต้องการลบคำเตือนบน WebStorm IDE คุณสามารถยกเลิกการเลือกตัวเลือกการตรวจสอบสำหรับ:

• ฟังก์ชัน Javascript ที่ไม่ได้รับการแก้ไข
• ตัวแปร Javascript ที่ไม่ได้รับการแก้ไข

ปล . สิ่งนี้จะลบคำเตือนใน IDE แต่ฉันไม่คิดว่านั่นเป็นความคิดที่ดีที่สุดเพราะเราจะสูญเสียหนึ่งในยูทิลิตี้ที่ดีที่สุดใน IDE เช่น Webstorm ซึ่งอาจทำให้คุณภาพของโค้ดแย่ลง

อย่างไรก็ตามหากคุณต้องการติดตามในเมนู: ไฟล์ > การตั้งค่า > ตัวแก้ไข > การตรวจสอบเราสามารถปิดการใช้งานคำเตือน Javascript

ดังภาพต่อไปนี้: