在PHP中注释变量列表


Annotate list of variables in PHP

我有一个对象列表,我通过以下方式检索:

list($var1, $var2, $var3) = $helper->getStuff();
除了长

现在,所有这些变量都属于同一个类,Foo,我想注释它们,以便IDE (PHPStorm)意识到我在做什么。

通常,每次获取一个变量,我会输入

/**@var Foo $var1 */
$var1 = ...;
/**@var Foo $var2 */
$var2 = ...;

等。但是我如何用list($var1, $var2, $var3) = ...;的方式来实现这一点呢?

理想情况下,应该是

/**@var Foo $var1, $var2, $var3 */

以便我可以将它们合并到一行中。是的,我试过了,用逗号和空格分隔。

您可以将它们全部放在它上面的单个块中。例如:

/**
 * @var Foo $var1
 * @var Foo $var2
 * @var Foo $var3
 */
list($var1, $var2, $var3) = $helper->getStuff();

如果使用单独的块,可以将它们全部插入一行,例如:

/**@var Foo $var1*/ /**@var Foo $var2*/ /**@var Foo $var3*/
list($var1, $var2, $var3) = $helper->getStuff();

但我怀疑这不是你所追求的简洁的可读性