如何在PhpDoc中指定对象数组

Question

我使用PhpDocumentor2来生成文档。 我搜索了这个主题，但是找不到具体的规则。 例如，我有一个名为AddressField的类，我想将我的$addressFields指定为AddressField对象的数组。

/**
 * @var AddressField[]
 */
private $addressFields;

- Farid Movsumov

---

@Jack，我查看了这个问题，但是我找不到答案。 - Farid Movsumov

如果这个 Eclipse thread 是可信的，你的语法在未来应该是可用的 :) - Ja͢ck

据我所知，您上面展示的格式是正确的。只是它并不被广泛支持。我知道PHPStorm至少使用了这种格式。 - Wige

@Jack，我来自未来，我可以确认你的评论。现在它是有效的。 - Robin van Baalen

Answer 1

phpdoc自己描述了数组的使用在这里:

1.4.4. 数组

• 未定义: @return array
• 单类型: @return int[]
• 多类型: @return (int|string)[]

变量定义应该也是如此:

/* @var Type[] $arr */

- schmijos

---

你也可以写成 int[]|string[]。 - gskema

还有一个建议的 PSR：PSR-5: PHPDoc on Arrays。 - Jens Kohl