Resultados da pesquisa a pedido "jsdoc"
Como documentar um Módulo Require.js (AMD) com jsdoc 3 ou jsdoc?
Eu tenho 2 tipos de módulos:Require.js Main File:
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 ...
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 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 ...
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 */ ...
Documentar parâmetro de função desestruturada no JSDoc
Anteriormente, eu sempre documentava meus parâmetros de objeto da seguinte maneira: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value ...
Documente os parâmetros de tipo genérico no JSDOC
EmJSDoc existe a possibilidade de documentar os tipos exatos de conteúdo do arraycomo isso:
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...