phpDoc, экземпляр класса как @param? - PullRequest
2 голосов
/ 15 ноября 2011

При использовании phpdoc для функции у меня есть аргумент, который всегда содержит экземпляр класса, есть ли способ документировать это в phpdoc, чтобы сгенерированный phpdoc связывался с данным классом?

Что-то вроде @param MyClass() $var.

Я не могу найти какую-либо информацию об этом в документации, фактически в документации даже не упоминаются параметры типа объектов (stdClass), точка.

1 Ответ

5 голосов
/ 15 ноября 2011

Вам нужно удалить скобки, и они должны работать из коробки:

@param MyClass $var Parameter takes instance of MyClass

Формальный синтаксис для этого:

@param type [$varname] description

Посмотрите документацию http://manual.phpdoc.org/HTMLframesConverter/default/ (нужно нажать на @param слева)

...