如何正确记录别名对象类型？

Question

如果我在别名下导入了一个类：

use My\Other\ClassName as OtherClass;

我该如何记录该类的类型？我是否使用别名？

a） @return \My\Other\ClassName

b） @return OtherClass

c）另一种方式？

Answer 1

PHPDoc支持完全限定的类，相对类，别名和对self的引用（static，$ this）

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

我见过的最常见的做法是使用完全限定的类名（例如\ My \ Other \ ClassName），在我看来，这是记录外部类的最好方法，因为阅读doc块的人没有＆＃ 39; t必须在另一个地方看一下，看看OtherClass所指的是什么。

如果使用phpstorm，请查看我最近提出的问题：Disable import of classes for PHPDoc