Resultados da pesquisa a pedido "jsdoc3"
Como faço para JSDoc um método de objeto aninhado?
Eu tenho tentado usar o JSDoc3 para gerar documentação em um arquivo, mas estou tendo alguma dificuldade. O arquivo (que é um módulo Require.js) basicamente ...
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 ...
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 ...
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 com AngularJS
Atualmente no meu projeto, estamos usando o JSDoc, começamos a implementar o Angular recentemente e quero continuar usando o JSDoc para garantir que toda a documentação esteja no mesmo local. Dei uma olhada nas pessoas dizendo apenas para usar o ...
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 * ...