JSDoc: Cấu trúc đối tượng trả về

Question

Làm cách nào tôi có thể cho JSDoc biết về cấu trúc của đối tượng được trả về. Tôi đã tìm thấy cú pháp @return {{field1: type, field2: type, ...}} description và thử nó:

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

Trong khi điều này phân tích thành công, các tài liệu hướng dẫn đơn giản rằng:

Returns: 
    The location of an event 
    Type: Object 

Tôi đang phát triển một API và cần mọi người biết về những đối tượng mà họ sẽ được trả lại. Điều này có thể xảy ra trong JSDoc không? Tôi đang sử dụng JSDoc3.3.0-beta1.

Answer 1

Xác định seperatly:

/** 
* @typedef {Object} Point 
* @property {number} x The X Coordinate 
* @property {number} y The Y Coordinate 
*/ 

Và sử dụng:

/** 
* 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 {Point} 
*   The location of the event 
*/ 
var getEventLocation = function(e, type) { 
    ... 

    return {x: xLocation, y: yLocation}; 
} 

Answer 2

Một giải pháp sạch là viết một lớp học và trở về đó.

/** 
* @class Point 
* @type {Object} 
* @property {number} x The X-coordinate. 
* @property {number} y The Y-coordinate. 
*/ 
function Point(x, y) { 
    return { 
     x: x, 
     y: y 
    }; 
} 

/** 
* @returns {Point} The location of the event. 
*/ 
var getEventLocation = function(e, type) { 
    ... 
    return new Point(x, y); 
};