Php 是否允许在文档中设置返回到json?
因此,在记录我正在编写的php代码时,我停止了我通常说的Php 是否允许在文档中设置返回到json?,php,json,string,Php,Json,String,因此,在记录我正在编写的php代码时,我停止了我通常说的@returnstring json输出,在我实际返回json的函数上 所以,我想知道设置是否正确 * * @return json */ public function test() { $test = array('hola' => array('en' => 'hello', 'ro' => 'salut')); return json_encode($test); } 而不是 * * @retur
@returnstring json输出
,在我实际返回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
*/
所以,我想这是一个正确的返回?“json
”在PHP中不是一个基本类型,事实上也不是任何类型。您需要记录返回的类型,而不是这些类型的内容的含义。如果将json
指定为返回“type”,这意味着类json
的对象,因为json
在PHP中没有其他含义
您只能将其记录为返回一个
字符串
,我更希望看到json的返回类型。确实,您是以字符串的形式返回json,但是json更为具体,并且让其他人知道会发生什么。正如orangepill所评论的,您应该使用类型string
并在描述中添加json
@返回字符串JSON
在参考数据类型时,手册说明
数据类型应该是一个有效的PHP类型(int、string、bool等),一个
返回的对象类型的类名,或简单的“混合”。如果你
要显式显示多个可能的返回类型,请列出它们
不带空格分隔的管道(例如“@return int | string”)
返回值应该是php类型。。。所以它是。。。但是可能会在注释
@return string json encoded return value
中指出它是json,所以,我应该坚持string
是的。。。你不会把@return html
或@return php\u serialized\u string
放进去,所以我不会把@return json
放进去。请查看我更新的问题,这样你就能理解我的疑问是从哪里开始的。希望您能够澄清为什么接受另一个。好吧,同样,任何不是PHP原语的东西都被当作类名。在您的示例中,返回了类视图的对象;我说如果你指定了json
,那就意味着一个类为json
的对象。返回的类型是自动工具,注释是给人的,json不是类型,它是一种编码。在这一点上,我总是尝试在PHP中对返回进行注释,因为返回的内容并不明显。
@return datatype description
@return datatype1|datatype2 description