В JSDoc лучшая документация, которую я могу найти, показывает, как использовать следующее, если у вас есть массив определенного типа (например, массив строк), например:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
Как бы вы заменили приведенные ниже вопросительные знаки указанием массива объектов?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
Ответы:
Вы должны уточнить, что вы подразумеваете под JSDoc - это общий термин, охватывающий практически все инструменты документации в стиле JavaDoc для JavaScript.
Синтаксис, который вы использовали для массива строк, похож на тот, который поддерживается компилятором Google Closure .
Используя это, массив объектов будет:
Или просто массив чего угодно - это должно работать практически со всеми инструментами документации:
jsdoc-toolkit , JSDoc 3 и JSDuck поддерживают следующий синтаксис для обозначения массива объектов:
РЕДАКТИРОВАТЬ
Если вы знаете ключи и тип переменных значений, вы также можете:
или
источник
{Array<Object>}
. Просто чтобы держать этот пост в актуальном состоянии.Array.<string[]>