Как правильно документировать типы объектов с псевдонимами?

Если я импортировал класс под псевдонимом:

use My\Other\ClassName as OtherClass;

Как я должен документировать типы этого класса? Использовать псевдоним или нет?

а) @return \My\Other\ClassName

б) @return OtherClass

c) Другой способ?


php namespaces phpdoc
person BadHorsie    schedule 18.10.2017    source источник

Ответы (1)


arrow_upward
0
arrow_downward

PHPDoc поддерживает полные классы, относительные классы, псевдонимы и ссылки на себя (статические, $this)

http://docs.phpdoc.org/guides/types.html

Наиболее распространенной практикой, которую я видел, является использование полных имен классов (например, \My\Other\ClassName), что, на мой взгляд, является лучшим способом документирования внешних классов, поскольку человеку, читающему блок документации, не нужно заглядывать в него. другое место, чтобы увидеть, на что ссылается OtherClass.

Если вы используете phpstorm, взгляните на вопрос, который я недавно задал: Отключить импорт классов для PHPDoc

person Devon    schedule 18.10.2017
comment
Я согласен, что имеет смысл использовать полное имя для ясности. Спасибо. - person BadHorsie; 18.10.2017