Есть ли способ для phpDoc документировать массив объектов в качестве параметра?

В документации, созданной phpDoc, я могу заставить phpDoc генерировать ссылку на определение пользовательского типа для данного параметра, используя

@param CustomType $variablename

, и это отлично работает. Однако код, который я в настоящее время документирую, требует параметров CustomType [], то есть массива указанного CustomType. Я хочу, чтобы в документации было четко указано, что требуется массив, но когда я использую

@param CustomType[] $variablename

, phpDoc больше не распознает тип и, следовательно, не может ссылаться на его определение. В данном случае это очень важно - я документирую API, который имеет несколько довольно сложных типов, которые необходимо предоставить.

Я пробовал несколько разных синтаксисов для этого, и все они либо обрабатывали записи как отдельные типы переменных, либо распознавали типы прерывания в документации.

За исключением этого, я просто отмечу это в примечании к параметру, но кажется более ясным показать массивность параметра в типе.

РЕДАКТИРОВАТЬ

С phpDocumentor 2 (который объединен с DocBlox) синтаксис

@param CustomType[] $paramName

работает, и, как отмечено в ответе @ Styx, PhpStorm поддерживает подсказку типов с этим синтаксисом.

Принятый ответ обновлен соответствующим образом.

20
задан cori 19 November 2012 в 14:42
поделиться