En JSDoc, la mejor documentación que puedo encontrar muestra cómo 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ía 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...
}
Respuestas:
Debería ser más específico lo que quiere decir con JSDoc: este es un término genérico que cubre prácticamente todas las herramientas de documentación de estilo JavaDoc para JavaScript.
La sintaxis que usó para la matriz de cadenas se parece a la que admite Google Closure Compiler .
Usando esto, una matriz de objetos sería:
O simplemente una variedad de cualquier cosa, esto debería funcionar con casi todas las herramientas de documentación:
jsdoc-toolkit , JSDoc 3 y JSDuck admiten la siguiente sintaxis para denotar una matriz de objetos:
EDITAR
En caso de que conozca las claves y el tipo de variable de los valores también puede hacer:
o
fuente
{Array<Object>}
. Solo para mantener esta publicación actualizada.Array.<string[]>