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 ...
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 ...
Komodo Editar literalmente o objeto JS de preenchimento automático
O problema é que o Komodo intelli-sense não vê métodos de objetos definidos desta maneira: var App = window.App || { method: function() { ... } } Digitando "App". não dá resultado. No entanto, definir um objeto como abaixo funciona bem: var ...
Como especificar uma matriz de objetos como um parâmetro ou valor de retorno no JSDoc?
No JSDoc, a melhor documentação que posso encontrar mostra como usar o seguinte se você tiver uma matriz de um tipo específico (como uma matriz de strings) c...
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 ...
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 o retorno em JavaScript
Estou escrevendo minha própria biblioteca para o projeto no trabalho para um aplicativo de navegador e estou tendo o mesmo problema antigo de decidir como co...
Compilador do Google Closure 100% digitado
Como faço para que meu aplicativo seja 100% digitado em relação ao compilador de fechamento do Google? Eu já marquei tudo com comentários jsdoc. É possível obter 100? Estou em 64,6%