No JSDoc, a melhor documentação que posso encontrar mostra como usar o seguinte se você tiver uma matriz de um tipo específico (como uma matriz de strings) como:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
Como você substituiria os pontos de interrogação abaixo para especificar uma matriz de objetos?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
Respostas:
Você deve ser mais específico sobre o que quer dizer com JSDoc - este é um termo genérico que cobre praticamente todas as ferramentas de documentação do estilo JavaDoc para JavaScript.
A sintaxe que você usou para a matriz de strings se parece com aquela suportada pelo Google Closure Compiler .
Usando isso, uma matriz de objetos seria:
Ou apenas uma variedade de qualquer coisa - isso deve funcionar com praticamente todas as ferramentas de documentação:
jsdoc-toolkit , JSDoc 3 e JSDuck suportam a seguinte sintaxe para denotar uma matriz de objetos:
EDITAR
Caso você conheça as chaves e o tipo de variável dos valores, você também pode fazer:
ou
fonte
{Array<Object>}
. Apenas para manter este post atualizado.Array.<string[]>