JSDoc: estrutura de objeto de retorno

144

Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei a @return {{field1: type, field2: type, ...}} descriptionsintaxe e tentei:

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

Enquanto isso analisa com êxito, a documentação resultante simplesmente afirma:

Returns: 
    The location of an event
    Type: Object

Estou desenvolvendo uma API e preciso que as pessoas saibam sobre o objeto que serão retornadas. Isso é possível no JSDoc? Estou usando JSDoc3.3.0-beta1.

javascript documentation-generation jsdoc code-documentation jsdoc3 Lobo preto
fonte
Eu sei que @typedefé uma solução / solução alternativa, mas parece estranho que isso não funcione com objetos literais. Se alguém se deparar com isso no futuro (como eu fiz), adicionei um problema no github.com/jsdoc/jsdoc/issues/1678 que poderia ter mais informações do que esta página.
Leszek

Respostas:

263

Defina sua estrutura separadamente usando um @typdef :

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

E use-o como o tipo de retorno:

/**
 * 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};
}
BGerrissen
fonte
2
Obrigado. De @returnfato, várias instruções funcionam, mas são listadas na saída como se fossem vários retornos (um ponto de marcador point - Objecte depois dois outros pontos para point.x - Numbere point.y - Number). Embora eu possa viver com isso, suponho que não há como ter uma saída condensada do objeto retornado? Ou pelo menos tem as entradas para point.xe point.yrecuado?
BlackWolf 27/02
1
Sim, essa parece ser a melhor opção. Eu pensei que poderia haver uma maneira de ter uma entidade de retorno sem nome, mas a @typedefabordagem é a mais clara em termos de saída da documentação, obrigado!
BlackWolf 27/02
groovy, removeu a primeira opção porque a segunda opção é simplesmente a melhor.
BGerrissen
1
É melhor você adicionar @innerou definir a definição terá globalescopo na documentação. +1
Onur Yıldırım
1
Eu sempre usei @typedef {Object} Point. De fato, o uso deste formulário de duas linhas é destacado Pointno PhpStorm com a mensagem "Variável não resolvida ou digite Point". Os @typedefdocumentos suportam isso, mas não quero editar esta resposta se for uma variante válida.
David Harkness
22

Uma alternativa às sugestões já postadas, você pode usar este formato:

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

que fornecerá a seguinte documentação:

    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.
Matt Pengelly
fonte
17

Uma solução limpa é escrever uma classe e devolvê-la.

/** 
 *  @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);
};
alces
fonte
Quando faço isso, mas uso o Google Closure Compiler, recebo um aviso: "não é possível instanciar não construtor". Tentei adicionar o @constructor à função (acima do @return), mas não ajudou. Se alguém souber como consertar isso, entre em contato. Obrigado!
AndroidDev
2
@AndroidDev isso é porque a função Pointnão é um construtor, a mudança que substitua o corpo da Pointfunção comthis.x = x; this.y = y;
Feirell
1
Não vejo a razão pela qual precisamos usar o novo aqui, por que não apenas retornar o Ponto (x, y)?
CHANist
@ CHANist, newsintaxe é criar uma instância do constructor. Sem new, o contexto de thisseria o contexto global. Você pode tentar criar uma instância sem newver o efeito.
Akash