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 ...
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 ...
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 ...
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 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 * ...
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 ...
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 * ...
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 ...
Como o jsdoc anota o código do BackboneJ
lguém já documentou o código BackboneJS com JSDo Estou tendo problemas para anotar construções do Backbone, como: User = Backbone.Model.extend({ defaults: { a: 1 }, initialize: function () { // ... }, doSomething: function (p) { // ... } }); ...
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 ...