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

Question

如果我有一个我正在访问的参数

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

我是否也使用@param标签，或仅用于

等参数

public function stageFiles($user, $project)

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

感谢。

Answer 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更喜欢它，只使用第二种语法。