php - 通过 __get 为 IDE 访问的文档变量

Question

有没有办法记录通过 __get 访问的变量IDE 可以识别它们的存在并返回类型的魔术方法？

例如我想公开 done和 helper通过 __get但也希望像 PHPStorm 这样的 IDE 能够知道它们的存在:

class Thing
{
    /** @var bool */
    private $done;

    /** @var HelperThing */
    private $helper;

    __get( $name )
    {
        if ( $name === "done" )
            return $done;

        if ( $name === "helper" )
            return $helper;
    }    
}

我试图避免使用像 $thing->getHelper() 这样的伪 setter/getter 方法因为我更喜欢 $thing->helper->someOtherMethod()的风格.

Answer 1

您可以使用 @property魔法属性的标签，以及 @method用于魔术方法文档。这些由 PHPStorm 支持。请参阅 @property 的文档和 @method了解更多信息。