【问题标题】:Is it possible to write PHPDoc documentation for @param without specifying the type?是否可以在不指定类型的情况下为 @param 编写 PHPDoc 文档?
【发布时间】:2019-08-26 14:39:27
【问题描述】:

我正在使用 PhpStorm。当我将以下 PHPDoc 文档用于函数时:

/**
 * @param $id application identifier
 */
public function foo($id)

我在 PHPStorm 中为该函数运行“快速文档”(Ctrl + Q)命令,它显示如下:

参数:App\Models\Application$id标识符

似乎出于某种原因,IDE 将参数描述的第一个字 application 解释为参数的类型。我不想指定参数的类型(我不知道它是什么),我只是想在文档中添加关于参数的简要说明。我该怎么办?

【问题讨论】:

  • 然后使用 mixed 类型(或其他一些通用类型)。 PHPDoc 需要类型。在您的情况下,IDE 将其视为类似于 PHPDoc 的语法,其中 type 位于名称之后。

标签: phpstorm phpdoc


【解决方案1】:

如果你不知道它是什么,你可以使用mixed。类型在$id之前,$id之后的部分将作为描述。

/**
 * @param mixed $id application identifier
 */
public function foo($id)

【讨论】:

    猜你喜欢
    • 2015-10-07
    • 1970-01-01
    • 2019-12-08
    • 2020-06-07
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2012-06-27
    • 1970-01-01
    相关资源
    最近更新 更多