php - 是否允许在文档中设置返回 json？

Question

因此，在记录我正在编写的 php 代码时，我在我通常所说的地方停止@return string The json output了我实际返回 json 的函数。

所以，我想知道设置是否正确

*
* @return json
*/
public function test()
{
    $test = array('hola' => array('en' => 'hello', 'ro' => 'salut'));
    return json_encode($test);
}

代替

*
* @return string
*/
public function test()
{
    $test = array('hola' => array('en' => 'hello', 'ro' => 'salut'));
    return json_encode($test);
}

我搜索了相关问题，并忽略了手册，但我所见过的没有提到我的疑问。

更新

作为一个参考，我从哪里开始做这一切。我看过几次，如下：

*
* @return View
*/

所以，我想这是一个适当的回报？

score 7 · Accepted Answer

" json" 不是 PHP 中的原始类型，实际上也不是任何类型。您需要记录返回的类型，而不是这些类型的内容的含义。如果您指定json为返回“类型”，这意味着一个类的对象json，因为json在 PHP 中没有其他含义。

您只能将其记录为返回一个string.

score 7 · Accepted Answer

正如 orangepill 评论的那样，您应该使用类型string并添加JSON描述。

@return string JSON

@return datatype description
@return datatype1|datatype2 description

关于数据类型，手册指出

数据类型应该是有效的 PHP 类型（int、string、bool 等）、返回对象类型的类名，或者简单地“混合”。如果您想显式显示多种可能的返回类型，请将它们以竖线分隔，不带空格（例如“@return int|string”）

score -1 · Accepted Answer

我更希望看到 json 的返回类型。确实，您以字符串的形式返回 json，但是 json 更具体，并让其他人知道会发生什么。