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

How to correctly document aliased object types?

如果我在别名下导入了 class:

use My\Other\ClassName as OtherClass;

我应该如何记录 class 的类型?我是否使用别名?

a) @return \My\Other\ClassName

b) @return OtherClass

c)另一种方式?

PHPDoc 支持完全限定的 classes、相对的 classes、别名和对 self (static, $this)

的引用

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

我见过的最常见的做法是使用完全限定的 class 名称(例如 \My\Other\ClassName),在我看来,这是记录外部 classes 的最佳方式,因为阅读文档块的人不必在不同的地方查看 OtherClass 所指的内容。

如果使用phpstorm,看看我最近问的一个问题: