Resultados da pesquisa a pedido "jsdoc"
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 documentar um dicionário no JSDoc?
Tendo o próximo exemplo:
JSDoc typedef em um arquivo separado
Posso definir todos os tipos personalizados em um arquivo separado (por exemplo,types.jsdoc), para que possam ser reutilizados em todo o aplicativo? Qual é o caminho certo para fazer isso? /** * 2d coordinates. * @typedef {Object} Coordinates * ...
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%
Maneira correta de documentar funções de argumento em aberto no JSDoc
Digamos que você tenha algo como o seguinte: var someFunc = function() { // do something here with arguments }Como você documentaria corretamente que essa função pode receber qualquer número de argumentos no JSDoc? Este é o meu melhor palpite, ...
Como JsDoc é do tipo "misto"?
Pergunta simples, como documentar esse "tipo misto"? Eu sei que eu poderia apenas listar todos os tipos possíveis, como{null|undefined|String|Number|Object} e acabo encontrando a falta de um e tornando-o excessivamente complexo. Tentei usar a ...
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 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 ...