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

时间:2017-06-21 07:38:08

标签: return documentation phpstorm phpdoc type-hinting

我非常喜欢PhpStorm及其文档生成器phpDoc。现在我在快速文档中与返回类型提示斗争。例如,我有这段代码:

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

ImportContainer课程中我有getType方法:

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

一切运作良好但是当我想使用PhpStorm的快速文档时,我会看到:

quick documentation

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

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

然后我会看到返回值:

enter image description here

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

我正在使用PhpStorm 2017.1.4

1 个答案:

答案 0 :(得分:4)

  

......或者我错过了什么并做错了?

不 - 它已经正常工作了。

  

并且没有任何返回值,返回类型提示应该是\Easyk\inout\InOutImportType

它在那里 - 再次检查(提示:检查那里的第一行 - 功能签名/声明)。

你在"返回" section是可选的(正如你已经注意到的那样)返回值的描述/解释(例如"返回项目数或错误&#34时为FALSE;)。

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