Как документировать контроллер в 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 считается тип возвращаемых данных according to the official phpDocumentor docs:

@return datatype description 
@return datatype1|datatype2 description