PHPDoc: Можно ли ссылаться на описания свойств объекта из docblock фабричного метода?

Если я использую фабричный метод для создания экземпляров объектов, то можно ли ссылаться на описания докблоков свойств класса для создаваемых объектов?

Я ловлю себя на том, что просматриваю классы, чтобы напомнить мне, какие параметры задавать фабричному методу. Было бы удобно, если бы я мог просто ссылаться на все соответствующие описания докблоков из всех объектов, которые выводит фабрика, тогда моя IDE подсказывала бы мне, когда я вызываю фабричный метод.


php phpdoc
person rgvcorley    schedule 07.04.2012    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Для описанного вами сценария лучший путь, который я вижу, - это реализовать все эти потенциальные классы с одним и тем же интерфейсом или, возможно, расширить один и тот же абстрактный родительский класс. Затем используйте @return в фабричном методе, чтобы сказать, что он возвращает объект этого интерфейса/абстрактного. Таким образом, IDE сможет считывать докблоки из кода интерфейса/резюме и предоставлять вам информацию.

person ashnazg    schedule 09.04.2012