在 PHPDoc 中为对象数组指定类型提示
要为对象数组声明 PHPDoc 标记,请使用以下语法:
@var array<\Fully\Qualified\Class\Name>
对于示例:
/** @var SomeObj[] */ private $someObjInstances;
此语法通知 IDE $someObjInstances 变量是 SomeObj 对象的数组。然后,IDE 将在使用该变量时提供适当的代码见解和类型检查。
IDE 支持
请注意,并非所有 IDE 都支持对象数组的此语法。例如,PHPEd 可能无法识别它。然而,PhpStorm 和 Visual Studio Code 等流行的 IDE 开箱即用地支持它。
替代语法
在 PHP 8.1 中,引入了另一种语法来指定类型数组中元素的个数:
@var array{key: type, key: type, ...}
对于示例:
/** @var array{object: SomeObj, string: string} */ private $someObjsArray;
此语法允许您指定数组中特定键的类型。它在处理关联数组时特别有用。
以上是如何在 PHPDoc 中指定对象数组的类型提示?的详细内容。更多信息请关注PHP中文网其他相关文章!