0
152
VistasConsulta para escribir la función en la propiedad javascript Object JSDoc
Necesito poner una función en un objeto javascript, ¿cómo agrego un comentario JSDoc en este caso?
/** * @typedef {Object} testObj * @property {!String} testName - testName * @property {?Function} [testFunction=null] - testFunction * */ var testObj = { testName:null, testFunction:null }De esta forma, nulo es el valor predeterminado de la función, por lo que se expresa así.
Solo quiero preguntar si es suficiente escribir solo @property {?Function} y escribir el parámetro en la parte Object, o si hay otra forma.
En la función de prueba anterior, quiero mostrar en JSDoc que se coloca una función con los parámetros {Number} a, {number} b, {Object} c . Si hay una manera, le agradecería que me lo hiciera saber. Y también quiero expresar que esta función devuelve un String .
1 Respuestas
Responde la pregunta0
Use @function para definir la función primero y luego use el nombre de la función en cualquier lugar que lo necesite, por ejemplo:
/** * A test function * * @function testFunction * @param {number} a Number a * @param {number} b Number b * @param {Object} c Object c * @returns {string} Returns a string */ /** * A test Object * * @typedef {Object} testObj * @property {!string} testName The Test Name * @property {?testFunction} testFunction The Test Function */ const testObj = { testName: null, testFunction: null, }Acabo de probarlo con jsdoc y la documentación se genera correctamente con el enlace en la propiedad testFunction.
