Resultados da pesquisa a pedido "jsdoc"
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 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 * ...
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 ...
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 */ ...
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 ...
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 * ...
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 * ...
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 ...
Como forçar novas linhas nas descrições jsdoc do Google Apps
Não consigo descobrir como, em um script do Google Apps, exibir isso corretamente. Eu preciso dele para exibir novas linhas na saída do jsdoc (por exemplo, quando a janela de dica de ferramenta da função aparecer em uma função da planilha.) Eu ...
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 ...