【问题标题】:Is it allowed to set return to json in documentation?是否允许在文档中设置返回 json?
【发布时间】:2013-07-10 15:48:33
【问题描述】:

因此,在记录我正在编写的 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);
}

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

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.return.pkg.html

更新

作为参考,我是从哪里开始的。我看过几次,如下:

*
* @return View
*/

所以,我想这是一个适当的回报?

【问题讨论】:

  • 返回值应该是php类型...所以是字符串...但可能会在cmets @return string JSON encoded return value中指出它是json@
  • 所以,我应该坚持string
  • 是的...你不会输入@return html 或@return php_serialized_string 所以我不会输入@return json

标签: php json string


【解决方案1】:

正如 orangepill 所说,您应该使用类型 string 并在说明中添加 JSON。

@return string JSON

PHPDoc Manual

@return datatype description
@return datatype1|datatype2 description

关于数据类型,手册说明

数据类型应该是有效的 PHP 类型(int、string、bool 等),a 类名表示返回的对象类型,或者简单地“混合”。如果你 想要显式显示多种可能的返回类型,列出它们 没有空格的管道分隔符(例如“@return int|string”)

【讨论】:

  • 在这点上,我总是尝试在 PHP 中对返回值进行注释,但返回的结果并不明显。
【解决方案2】:

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

您只能将其记录为返回string。

【讨论】:

  • 请查看我更新的问题,以便您了解我的疑问从哪里开始。希望您能够澄清为什么另一个被接受
  • 好吧,再一次,任何不是 PHP 原语的东西都被视为 类名。在您的示例中,返回一个类 View 的对象;我说如果你指定json,那将意味着json类的对象。
【解决方案3】:

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

【讨论】:

  • 返回的类型是自动化工具,cmets是人类,json不是类型,是编码。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2011-10-25
  • 2013-12-12
  • 1970-01-01
  • 2019-04-16
  • 1970-01-01
  • 1970-01-01
  • 2012-04-13
相关资源
最近更新 更多