如何正确记录别名的对象类型?
问题描述:
如果我有一个别名下进口类:如何正确记录别名的对象类型?
use My\Other\ClassName as OtherClass;
我应该如何记录类型的类的?我是否使用别名?
一个)@return \My\Other\ClassName
B)@return OtherClass
c)中另一种方法?
答
PHPDoc的支持完全合格的类,相对班,别名和引用自(静态,这$)
http://docs.phpdoc.org/guides/types.html
最常见的做法,我是使用完全合格的类名看到(如\ My \ Other \ ClassName),在我看来,这是记录外部类的最好方式,因为阅读doc块的人不必在另一个地方查看OtherClass引用的内容。
如果使用phpstorm,看看一个问题,我问最近:Disable import of classes for PHPDoc
我同意这使得使用完全合格的名称为清楚起见,更有意义。谢谢。 – BadHorsie