【问题标题】:How to document PHP @return when you are returning view in MVC在 MVC 中返回视图时如何记录 PHP @return
【发布时间】:2014-11-05 20:20:21
【问题描述】:

假设在我的控制器中,我想在我的一些方法中返回这样的视图:

return $this->render('home', [
    'model' => $model,
]);

在我的文档块中,我想记录此方法返回的内容。我不知道如何记录此方法正在返回视图。那是资源吗?是混合的吗?

这有效吗? :

@return resource

您如何记录您的方法正在返回重定向到其他页面?

【问题讨论】:

  • 你正在返回一个字符串,正如我所看到的那样

标签: php yii return docblocks


【解决方案1】:

您的 docblock 只是在 IDE 中为您提供输入提示,并使内容更具可读性。你绝对可以做@return 资源,如果那是你要返回的,但你也可以只包含更多的 cmets

/**
*  This function returns a view which then redirects the user to another page
*
*  @param string $model The model we looked at
*  @return resource The page to redirect to
*/
function foo($model){
    return $this->render('home', [
    'model' => $model,
    ]);
}

如果你的框架中有一个更具体的类来说明 $this->render 的实际返回是什么,那么你可能应该包含它,但如果你说 $this->render 重定向页面,那么实际上有没有理由在这个函数中返回它,因为这些调用不会发生,它可以只是一个 void 函数(或者你可以返回一个布尔值以防万一失败)

【讨论】:

  • 我正在使用 yii2 框架,你必须返回对视图的调用。那么视图可以被认为是一种资源吗?我知道通常您在返回数据库连接和查询调用时使用资源。
  • 所以如果你在谈论:yiiframework.com/doc-2.0/… 你可以看到 render 的返回类型是一个字符串。您的 docblock 应该只反映您返回的实际类类型或原始类型。
  • 哇,我从没想过要查阅 API 文档。还有一个问题,“资源”一词对我来说有点模糊。你能解释一下在哪里使用它是合适的吗?
  • 没问题,资源是一种特殊类型的变量,具体可以看这里的php文档:php.net/manual/en/language.types.resource.php
  • 感谢您的帮助!
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2012-11-22
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-06-26
  • 1970-01-01
  • 2011-04-06
相关资源
最近更新 更多