Resultados de la búsqueda a petición "jsdoc"
Cómo forzar nuevas líneas en las descripciones jsdoc de Google Apps
No puedo entender cómo en un script de Google Apps mostrar esto correctamente. Lo necesito para mostrar nuevas líneas en la salida de jsdoc (por ejemplo, cuando aparece la ventana de información sobre herramientas de funciones en una hoja de ...
jsdoc: descripción multilínea @property
Estoy documentando mi código usando jsdoc, hasta ahora todo bien, tengo un comentario como el siguiente ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property...y viene en documento ...
JSDoc: Estructura de objeto de retorno
¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? He encontrado el@return {{field1: type, field2: type, ...}} description sintaxis y lo probé: /** * Returns a coordinate from a given mouse or touch event * ...
Cómo documentar una función devuelta por una función utilizando JSDoc
Estoy usando JSDoc para la documentación de parámetros. Está claro cómo documentar los tipos de parámetros paramany_prompts, pero ¿cuál es la forma correcta de documentar la función que devuelve? /** * @param {Number} - number of times to ...
Documente el parámetro de función desestructurada en JSDoc
Anteriormente, siempre he documentado mis parámetros de objeto de la siguiente manera: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value ...
JSDoc typedef en un archivo separado
¿Puedo definir todos los tipos personalizados en un archivo separado (p. Ej.types.jsdoc), para que puedan reutilizarse en toda la aplicación? ¿Cuál es la forma correcta de hacerlo? /** * 2d coordinates. * @typedef {Object} Coordinates * ...
¿Cómo JsDoc un tipo "mixto"?
Pregunta simple, ¿cómo documento ese "tipo mixto"? Sé que podría enumerar todos los tipos posibles como{null|undefined|String|Number|Object} y termino encontrándome perdiendo uno y haciéndolo demasiado complejo. Intenté usar la palabra clave ...
¿Cómo jsdoc anotar el código BackboneJS?
¿Alguien ha documentado alguna vez el código BackboneJS con JSDoc? Tengo problemas para anotar construcciones de Backbone como: User = Backbone.Model.extend({ defaults: { a: 1 }, initialize: function () { // ... }, doSomething: function (p) { ...
Komodo Editar autocompletado objeto JS literal
El problema es que Komodo intelli-sense no ve métodos de objetos definidos de esta manera: var App = window.App || { method: function() { ... } } Escribiendo "Aplicación". no da ningún resultado. Sin embargo, definir un objeto como el ...
Cómo documentar retorno en JavaScript
Estoy escribiendo mi propia biblioteca para el proyecto en el trabajo para una aplicación de navegador y tengo el mismo viejo problema de decidir cómo coment...