绕过注释Symfony2

Question

我目前正在使用Symfony2构建RESTful API。

为了创建一个简单而干净的文档，我希望使用apidoc.js（我真的更喜欢使用这个，但是如果你有其他任何可以自动生成api文档的话，可以随意分享）。< / p>

这个生成器使用由Symfony内核解析的注释（显然，根据我的理解）

这是我的控制器代码

/**
 * @api {get} /contact/list Request Contacts List
 * @apiName List Contacts
 * @apiGroup Contacts
 *
 * @apiSuccess {Integer} Status
 * @apiSuccess {String} Custom Message to be displayed
 */
public function clientListAction(){}

可悲的是，Symfony对此进行了解析，并向我抛出了一个错误：

[Semantical Error] The annotation "@apiName" in method AppBundle\Controller\ClientApiController::clientListAction() was never imported.

你是否碰巧有一个解决方案要么阻止Symfony解析注释（我总是使用YAML，所以Symfony注释实际上对我没用），或者只是导入那些？

我对此非常陌生，我仍然在努力创建一个可靠而干净的Symfony应用程序。

Answer 1

使用@ignoreAnnotation。

  

使用其他库或程序（例如Doxygen）时使用   注释，你应该将@IgnoreAnnotation注释放在   用于指示Symfony应忽略哪些注释的类。