php - 在 PHPDoc 中声明局部变量的属性

Question

我有一个带有一些属性的 stdClass 实例。在 PHPDoc 中声明这些属性的正确方法是什么？我试过了，但似乎不行:

    /** 
     * @var $requestParams stdClass
     * @property string cancelUrl 
     */
    $requestParams = $someObj->getSomething();

Answer 1

鉴于您的代码示例，您可以做的最好的事情是通过 @var 表示 $requestParams 是 stdClass 类型。您对 @property 的使用不会为您做任何事情，因为该标记专门为类中存在的魔术属性定义...因此，@property只有在类文档 block 中时才会被读取和解释。

如果您只需要显示 $requestParams 是 stdClass 的一个实例，那么@var 就是您所需要的。但是，如果您还想表示 $requestParams->cancelUrl 是一个已知的字符串属性，而不更改为实际定义的类，则必须使用另一个局部变量，就像 $requestParams 是局部变量一样:

/** @var stdClass $requestParams */
$requestParams = $someObj->getSomething();

/** @var string $cancelUrl */
$cancelUrl = $requestParams->cancelUrl;

除了回答您的直接问题之外——如果向您的读者展示此 $requestParams 元素具有某些定义的属性对您来说真的很重要，我会选择为其编写一个正式的类。当然，该类中的实现仍然可以只是一个用于保存值的内部 stdClass。