为两种不同类型注释PHP变量

时间:2016-05-03 08:47:42

标签: php annotations

背景

鉴于我有gimme()可以返回ClassA的实例或ClassB的实例,我想要注释收到它的变量。

$gotIt = gimme();

问题

现在我想注释这个变量,但由于它可以是ClassAClassB,我可以同时覆盖它们吗?

在伪,这就是我想要的

/** @var (ClassA OR ClassB) $gotIt */
$gotIt = gimme();

1 个答案:

答案 0 :(得分:0)

正如Mark Ba​​ker评论的那样,/** @var ClassA|ClassB $gotIt */正确地告诉IDE该变量可以是这两个类之一的实例。

然后,IDE可以提供诸如自动完成,跳转到源或其他功能之类的内容,而不是标记无法找到的警告,例如$gotIt->someFunction()