PhpStorm - 快速文档中的返回类型提示

Posted 2023-03-22

【中文标题】PhpStorm - 快速文档中的返回类型提示

【英文标题】：PhpStorm - return type hinting in quick documentation

【发布时间】：2017-11-23 23:30:27

【问题描述】：

我真的很喜欢 phpStorm 和它的文档生成器 phpDoc。现在我在快速文档中处理返回类型提示。例如我有这个代码：

$import_type = $this->importContainer->getType()->getSelectedSchema();

在ImportContainer 类中我有这个getType 方法：

/**
 * @return \Easyk\inout\InOutImportType
 */
public function getType() 
    return $this->type;

一切正常，但是当我想使用 PhpStorm 的快速文档时，我会看到：

并且没有任何返回值，返回类型提示应该是\Easyk\inout\InOutImportType。我发现如果我有这种类型的提示：

/**
 * @return \Easyk\inout\InOutImportType $importType
 */

然后我会看到返回值：

根据@return 语法中的phpDoc documentation，描述是可选的，那么为什么我必须描述返回值才能在快速文档中看到它？对我来说，最好只是在快速文档中查看确切的返回类型提示 - 无需描述。我在 PhpStorm 中没有找到任何启​​用它的选项，是否有任何解决方法或者我错过了什么并且做错了？

我正在使用 PhpStorm 2017.1.4

【参考方案1】：

...或者我错过了什么并且做错了？

不——它已经可以正常工作了。

而且没有任何返回值，返回类型提示应该是\Easyk\inout\InOutImportType。

在那里——再次检查（提示：检查那里的第一行——函数签名/声明）。

---

您在“返回”部分看到的是可选的（正如您自己注意到的）返回值的描述/解释（例如“返回项目数或错误时为 FALSE”）。

实际的返回类型列在第一行函数签名的末尾。

【讨论】：

谢谢，我错过了那个函数签名，我希望它在返回部分。