ฉันจะบอก JSDoc เกี่ยวกับโครงสร้างของวัตถุที่ส่งคืนได้อย่างไร ฉันพบ@return {{field1: type, field2: type, ...}} description
ไวยากรณ์แล้วลอง:
/**
* Returns a coordinate from a given mouse or touch event
* @param {TouchEvent|MouseEvent|jQuery.Event} e
* A valid mouse or touch event or a jQuery event wrapping such an
* event.
* @param {string} [type="page"]
* A string representing the type of location that should be
* returned. Can be either "page", "client" or "screen".
* @return {{x: Number, y: Number}}
* The location of the event
*/
var getEventLocation = function(e, type) {
...
return {x: xLocation, y: yLocation};
}
ในขณะที่วิเคราะห์คำนี้สำเร็จเอกสารที่เป็นผลลัพธ์จะระบุเพียง:
Returns:
The location of an event
Type: Object
ฉันกำลังพัฒนา API และต้องการให้ผู้คนรู้เกี่ยวกับวัตถุที่พวกเขาจะได้รับคืน เป็นไปได้ใน JSDoc? ฉันใช้ JSDoc3.3.0-beta1
@typedef
นี่เป็นวิธีแก้ปัญหา / วิธีแก้ปัญหา แต่มันดูแปลกสำหรับเรื่องนี้ที่จะไม่ทำงานกับวัตถุที่แท้จริง หากใครก็ตามที่พบสิ่งนี้ในอนาคต (อย่างที่ฉันทำ) ฉันได้เพิ่มปัญหาgithub.com/jsdoc/jsdoc/issues/1678ซึ่งอาจมีข้อมูลมากกว่าหน้านี้