javascript - tutorial - ¿Cómo especificar una matriz de objetos como parámetro o valor de retorno en JSDoc?
jsdoc tutorial (1)
En JSDoc, la mejor documentación que puedo encontrar muestra que debe usar lo siguiente si tiene una matriz de un tipo específico (como una matriz de cadenas) como:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
¿Cómo reemplazarías los siguientes signos de interrogación para especificar una matriz de objetos?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
Debería ser más específico a lo que se refiere con JSDoc: este es un término genérico que cubre prácticamente todas las herramientas de documentación al estilo JavaDoc para JavaScript.
La sintaxis que usó para una matriz de cadenas se parece a la que admite Google Closure Compiler .
Usando esto, una matriz de Objetos sería:
/**
* @param {Array.<Object>} myObjects
*/
O simplemente una matriz de cualquier cosa, esto debería funcionar con casi todas las herramientas de doc:
/**
* @param {Array} myArray
*/
jsdoc-toolkit , JSDoc 3 y JSDuck admiten la siguiente sintaxis para denotar una matriz de objetos:
/**
* @param {Object[]} myArray
*/
EDITAR
En caso de que conozca las claves y el tipo de variable de los valores, también puede hacer:
/**
* @param {Array.<{myNumber: Number, myString: String, myArray: Array}>} myObjects
*/
o
/**
* @param {{myNumber: Number, myString: String, myArray: Array}[]} myObjects
*/