วิธีระบุอาร์เรย์ของวัตถุเป็นพารามิเตอร์หรือค่าส่งคืนใน JSDoc

ใน JSDoc เอกสารที่ดีที่สุดที่ฉันสามารถหาได้แสดงให้ใช้สิ่งต่อไปนี้หากคุณมีอาร์เรย์ประเภทเฉพาะ (เช่นอาร์เรย์ของสตริง) เป็น:

/**
 * @param {Array.<string>} myStrings All my awesome strings
 */
 function blah(myStrings){
     //stuff here...
 }

คุณจะแทนที่เครื่องหมายคำถามด้านล่างเพื่อระบุอาร์เรย์ของวัตถุได้อย่างไร

/**
 * @param {???????} myObjects All of my equally awesome objects
 */
 function blah(myObjects){
     //stuff here...
 }

คุณควรเจาะจงมากขึ้นว่าคุณหมายถึงอะไรโดย JSDoc - นี่เป็นคำทั่วไปที่ครอบคลุมเครื่องมือเอกสารสไตล์ JavaDoc ทั้งหมดสำหรับ JavaScript

ไวยากรณ์ที่คุณใช้สำหรับอาร์เรย์ของสตริงลักษณะอย่างหนึ่งที่ได้รับการสนับสนุนโดยGoogle ปิดคอมไพเลอร์

เมื่อใช้สิ่งนี้อาร์เรย์ของวัตถุจะเป็น:

/**
 * @param {Array.<Object>} myObjects
 */

หรืออาร์เรย์ของอะไรก็ได้ - สิ่งนี้ควรใช้ได้กับเครื่องมือ doc ทั้งหมด:

/**
 * @param {Array} myArray
 */

jsdoc-toolkit , JSDoc 3และJSDuckสนับสนุนไวยากรณ์ต่อไปนี้เพื่อแสดงอาร์เรย์ของวัตถุ:

/**
 * @param {Object[]} myArray
 */

แก้ไข

ในกรณีที่คุณทราบคีย์และประเภทตัวแปรของค่าคุณสามารถทำได้:

/**
 * @param {Array.<{myNumber: Number, myString: String, myArray: Array}>} myObjects
 */

หรือ

/**
 * @param {{myNumber: Number, myString: String, myArray: Array}[]} myObjects
 */