JSDoc: возвращает структуру объекта

как я могу рассказать 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.

2 77
javascript code-documentation jsdoc documentation-generation jsdoc3

2 ответа:

определить отдельно:

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

чистое решение состоит в том, чтобы написать класс и вернуть его.

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