Как документировать контроллер в Symfony?

Question

Я пытаюсь документировать свой проект. Я хочу документировать свой контроллер. До моего действия у меня есть:

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

Возвращаемое значение здесь покажет:

Зачем?

Спасибо

РЕДАКТИРОВАТЬ:

Стандартный контроллер:

public function myControllerAction(Request $request) {

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

Answer 1

Аннотация @return ожидает тип данных в качестве первого аргумента перед описанием. В вашем случае вы указали тип данных как views который не был включен с use оператор, поэтому PHP предполагает, что он принадлежит текущему пространству имен, и вы получите \AppBundle\Controllers\views, Возвращаемый тип контроллера должен быть Symfony\Component\HttpFoundation\Response, Итак, вы хотите:

@return \Symfony\Component\HttpFoundation\Response description

или если у вас уже есть use заявление для ответа:

@return Response description

В некоторых случаях вы можете захотеть быть более конкретным, если вы всегда возвращаете определенный подкласс ответа, например:

• BinaryFileResponse
• JsonResponse
• RedirectResponse
• StreamedResponse

Answer 2

Причина в том, что первое слово после @return считается тип возвращаемых данных в соответствии с официальными документами phpDocumentor:

@return datatype description
@return datatype1|datatype2 description