如何在 symfony 中记录控制器？

Question

我正在尝试记录我的项目。我想记录我的控制器。在我采取行动之前，我有：

/**
 * Description: xxx
 * @param parameters of my function Action
 * @return views of the action
 */

这里的return值会显示：

为什么？

谢谢

编辑：

标准控制器：

public function myControllerAction(Request $request) {

    return $this->render('AppBundle:Default:index.html.twig');
}

Answer 1

原因是@return之后的第一个词被认为是返回数据的类型according to the official phpDocumentor docs:

@return datatype description
@return datatype1|datatype2 description

Answer 2

@return 注解需要数据类型作为第一个参数，在描述之前。在您的情况下，您已将数据类型指定为 views ，但未包含在 use 语句中，因此 PHP 假定它属于当前名称空间并且您得到 \AppBundle\Controllers\views. return 类型的控制器必须是 Symfony\Component\HttpFoundation\Response。所以你想要：

@return \Symfony\Component\HttpFoundation\Response description

或者如果您已经有一个 use 响应语句：

@return Response description

在某些情况下，如果您总是 return 响应的特定子类，您可能希望更具体，例如：

如何在 symfony 中记录控制器？

How to document a controller in symfony?

symfony

phpdocumentor2