[javascript] JSDoc : 객체 구조 반환

Program / 글쓴이

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을 사용하고 있습니다.

답변

@typdef를 사용 하여 구조를 별도로 정의하십시오 .

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

답변

이미 게시 된 제안에 대한 대안으로 다음 형식을 사용할 수 있습니다.

/**
 * Get the connection state.
 *
 * @returns {Object} connection The connection state.
 * @returns {boolean} connection.isConnected Whether the authenticated user is currently connected.
 * @returns {boolean} connection.isPending Whether the authenticated user's connection is currently pending.
 * @returns {Object} connection.error The error object if an error occurred.
 * @returns {string} connection.error.message The error message.
 * @returns {string} connection.error.stack The stack trace of the error.
 */
getConnection () {
  return {
    isConnected: true,
    isPending: false,
    error
  }
}

다음과 같은 문서 출력이 제공됩니다.

    Get the connection state.

    getConnection(): Object

    Returns
    Object: connection The connection state.
    boolean: connection.isConnected Whether the authenticated user is currently connected.
    boolean: connection.isPending Whether the authenticated users connection is currently pending.
    Object: connection.error The error object if an error occurred.
    string: connection.error.message The error message.
    string: connection.error.stack The stack trace of the error.

답변

깨끗한 해결책은 클래스를 작성하여 반환하는 것입니다.

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

답변