如何为函数声明中未明确指定的参数编写 PHPDoc

【问题标题】：How to write PHPDoc for parameters not specifically specified in the function declaration如何为函数声明中未明确指定的参数编写 PHPDoc
【发布时间】：2014-03-16 10:22:39
【问题描述】：

如果我有一个像这样访问的参数

$msg = Input.get("message");

我是否也使用@param 标记，还是仅用于像

这样的参数

public function stageFiles($user, $project)

另外，当你返回一个 json 对象时，正确的记录方法是什么。

谢谢。

【问题讨论】：

@param 仅用于函数（方法）参数
对非函数变量（参数）使用@var。

标签： php documentation phpdoc

【解决方案1】：

JSON 不是公认的 PHP 数据类型，因此您应该使用字符串或 stdClass，具体取决于该 $msg 变量表示 JSON 的实际方式。

如果您想记录 $msg 的数据类型，有一些 IDE 可以识别的非正式语法：

/** @var string $msg a JSON string */
$msg = Input . get("message");

同样，这是一些 IDE 可以识别的非正式语法。我认为一些 IDE 会在变量名之后寻找数据类型：

/** @var $msg string a JSON string */

两者都不被认为是“标准”用法，但第一个已被提议在 PHP-FIG 的 PSR-5 草案中成为标准化。我建议使用它，并且仅在您的 IDE 更喜欢它时才使用第二种语法。

【讨论】：