Resultados de la búsqueda a petición "jsdoc"
¿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 */ ...
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 ...
Compilador de cierre de Google 100% escrito
¿Cómo puedo hacer que mi aplicación se escriba al 100% con respecto al compilador de cierre de Google? Ya etiqueté todo con comentarios de jsdoc. ¿Es posible obtener 100? Estoy en 64,6%
Forma correcta de documentar funciones de argumentos abiertos en JSDoc
Digamos que tiene algo como lo siguiente: var someFunc = function() { // do something here with arguments }¿Cómo documentaría correctamente que esta función puede tomar cualquier número de argumentos en JSDoc? Esta es mi mejor suposición, pero ...
Enum como tipo @param en JSDoc
¿Es posible usar una enumeración para el JSDoc@param tipo de declaración como en el siguiente ejemplo? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { }Si uso un IDE ...
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() ...
¿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 ...
Documentar parámetros de tipo genérico en JSDOC
EnJSDoc Existe la posibilidad de documentar los tipos exactos de contenido de matriz.Me gusta 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: