जेएसडीओसी: रिटर्न ऑब्जेक्ट स्ट्रक्चर

Question

मैं जेएसडोक को वापस लौटाए गए ऑब्जेक्ट की संरचना के बारे में कैसे बता सकता हूं। मैं @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 

मैं एक एपीआई के विकास और लोगों की जरूरत है हूँ वस्तु के बारे में पता चला है कि वे वापस आ जाएगा। क्या यह जेएसडीओसी में संभव है? मैं JSDoc3.3.0-beta1 का उपयोग कर रहा हूं।

Answer 1

seperatly परिभाषित करें:

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

और उपयोग:

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

एक साफ समाधान एक वर्ग लिख सकते हैं और वापस जाने कि है।

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