Resultados da pesquisa a pedido "jsdoc"
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 posso documentar o projeto Backbone AMD + com JSDoc3
eu tenho umBoilerplate espinha dorsal projeto com base, que eu quero documentar com recenteskit de ferramentas jdocEmbora eu não consiga gerar nada além da c...
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 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 */ ...
Função sobrecarregada de documento no JSDoc
Estou sobrecarregadoalternanciafunção e deseja documentar os comportamentos com JSDoc. Se o valor for definido, o estado da janela será definido como o valor booleano do parâmetro truthy, se indefinido, o estado da janela será alternado. ...
JSDoc: Como documentar o objeto literal "opções" para uma "classe" pai? [duplicado
Esta pergunta já tem uma resposta aqui: Como descrever argumentos de "objeto" no jsdo [/questions/6460604/how-to-describe-object-arguments-in-jsdoc] 5 respostasEstou usando o jQuery's$.widget() base "class", que fornece umoption() método. Como ...
Como documentar retornos de chamada usando o JSDoc?
Dada uma função Javascript que usa funções de retorno de chamada como parâmetros:
Como documentar um dicionário no JSDoc?
Tendo o próximo exemplo:
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 ...