如何在 php 中输入提示 $this 的属性？

Question

假设在

template.phtml

中，有一个定义在

someInstance

上的类

SomeClass

的属性

$this

。

因此在文件中，可以访问：

$this->someInstance

但是开发者并没有立即知道

$this->someInstance

是什么类型。

我知道我可以即时输入提示：

<?php

class SomeClass {
    public int $foo;
    public string $bar;
}


$someInstance = $this->someInstance;
/**
 * @var SomeClass $someInstance
 */
$someInstance-> // I have autocompletion here

有没有办法直接为

$this->someInstance

提供 phpdoc，而不需要通过额外的局部变量？

我的目标是向现有文件添加代码文档，而不增加太多重构噪音。

我尝试过：

/**
 * @var SomeClass $this->someInstance
 */

和：

/**
 * @var SomeClass $this::someInstance
 */

但这并没有奏效。

Answer 1

作为解决方法，您可以添加类作为视图的文档，例如对于您的 template.phtml，添加：

class TemplateView {
    public SomeClass $someInstance;
}

然后你可以输入提示

$this

:

/**
 * @var TemplateView $this
 */
$this-> // you have autocomplete here

---