Resultados da pesquisa a pedido "jsdoc"
Enum como tipo @param no JSDoc
É possível usar uma enumeração para o JSDoc@param declaração de tipo como no exemplo a seguir? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { }Se eu usar um IDE como ...
Qual é a maneira correta de documentar retornos de chamada com o jsdoc?
Passei um bom tempo vasculhando a Internet procurando a melhor maneira de documentar adequadamente os retornos de chamada com o jsdoc, mas, infelizmente, ainda não encontrei um ótimo. Aqui está a minha pergunta: Estou escrevendo uma biblioteca ...
Como exibir métodos Javascript em um 'grupo' no JSDOC?
Existe a possibilidade de 'agrupar' funções dentro de uma classe (AMD / RequireJS Module)? Minhas aulas às vezes têm mais de 20 funções que realmente pertencem a uma 'implementação de interface' específica e às vezes precisam ser agrupadas para ...
Como anotar middlewares Express com JSDoc?
Estou tentando documentar um middleware Express, mas a ferramenta de validação incorporada no WebStorm informa que os tipos são atribuídos incorretamente no seguinte bloco JSDoc: /** * My middleware. * * @param {Object} req * @param {Object} res ...
Como forçar novas linhas nas descrições jsdoc do Google Apps
Não consigo descobrir como, em um script do Google Apps, exibir isso corretamente. Eu preciso dele para exibir novas linhas na saída do jsdoc (por exemplo, quando a janela de dica de ferramenta da função aparecer em uma função da planilha.) Eu ...
jsdoc: descrição de várias linhas @property
Estou documentando meu código usando jsdoc, até agora tudo bem, tenho um comentário como abaixo ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property...e ele vem no documento html ...
JSDoc: estrutura de objeto de retorno
Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei o@return {{field1: type, field2: type, ...}} description sintaxe e tentei: /** * Returns a coordinate from a given mouse or touch event * ...
Como documentar uma função retornada por uma função usando JSDoc
Estou usando o JSDoc para documentação de parâmetros. Está claro como documentar os tipos de parâmetros paramany_prompts, mas qual é a maneira correta de documentar a função que ela retorna? /** * @param {Number} - number of times to prompt * ...
Texto e conteúdo "Home" padrão para JSDoc
Após executar uma compilação / renderização básica do JSDoc a partir do Node.js: jsdoc file1.js file2.jsEu recebo um documento bem formatado usando o modelo padrão dentro de um diretório "out". Quase tudo é como o esperado! Porém, ao abrir o ...
Como estender um parâmetro typedef no JSDOC?
Supondo que você tenha o seguinte código dentro de uma classe ES6 (documentação): /** * @typedef Test~options * @type {object.<string>} * @property {array} elements - An array containing elements * @property {number} length - The array length */ ...