Resultados de la búsqueda a petición "jsdoc"
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: 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: ¿Cómo documento el literal de objeto "opciones" para una "clase" primaria? [duplicar
Esta pregunta ya tiene una respuesta aquí: ¿Cómo describir los argumentos de "objeto" en jsdoc? [/questions/6460604/how-to-describe-object-arguments-in-jsdoc] 5 respuestas Estoy usando jQuery's$.widget() base "clase" que proporciona unaoption() ...
Documentando funciones de miembros con JSDoc
Tengo algo como esto:
¿Cómo documentar las devoluciones de llamada utilizando JSDoc?
Dada una función de Javascript que toma las funciones de devolución de llamada como parámetros:
¿Cómo extender un parámetro typedef en JSDOC?
Suponiendo que tiene el siguiente código dentro de una clase ES6 (documentación): /** * @typedef Test~options * @type {object.<string>} * @property {array} elements - An array containing elements * @property {number} length - The array length */ ...
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 se documenta una matriz de objetos como un parámetro en JSDoc?
Tengo una matriz que se parece a esto:
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 * ...