想象一下以下假设的类结构,在所有 PHPdoc 提示都正确设置的情况下,这并不是一个非常罕见的场景:
class BaseFilter {
/** ...base methods... */
}
class TextFilter extends BaseFilter {
public function setMinLength($len)
{
/** ...irrelevant */
}
}
class SomethingWithFilters
{
/**
* @param BaseFilter $filter A valid filter to be added.
* @return BaseFilter The filter that was added for easy chaining
*/
public function addFilter(BaseFilter $filter)
{
$this->filters[] = $filter;
return $filter;
}
/** @var BaseFilter[] A list of filters */
private $filters = [];
}
现在我使用这段代码如下:
$myClass = new SomethingWithFilters();
$myClass->addFilter(new TextFilter())->setMinLength(8);
在 phpStorm(可能还有大多数其他 IDE,因为它有意义)中,第二行会产生一个警告,指出BaseFilter
不包含方法setMinLength
。虽然绝对正确,但这是有意的多态行为,充分利用 PHP 的后期绑定特性 - 在像 C# 这样的语言中,您必须显式向上转换。因此,我希望 phpDoc 语法在这里支持某种动态符号,指出返回类型addFilter
与$filter
提供的类型。
我尝试将其更改为:
@return $filter
但这只是作为参考显示BaseFilter
并被如此对待,仍然发出警告。
有没有什么标准化的方法可以实现这种效果,至少让常见的IDE能够理解?
IDE 在这里可以做的最好的事情可能是,如果 addFilter() 上的 @return 实际上列出了可以返回的所有可能的 BaseFilter 子项:
@return BaseFilter|TextFilter|AnotherFilter
This might触发您的 IDE 为所有可能的返回类提供所有可能的方法。这取决于所使用的 IDE 是否知道如何识别这样一个可能的返回类型列表。显然,将这样的列表放入许多返回标签中,这对您来说会变得乏味。
我不知道有任何 IDE 会单独查看 BaseFilter 的返回类型,生成所有可能的父+子方法的列表,从而使整个列表可用于自动完成自动地.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)