class App\Controller\UserController 中的注释“@apiDefine”从未导入

Question

我同时使用 phpstan 和 apidoc，但我在 phpstan 上遇到错误，我找不到解决或忽略的方法。


 Error message "Internal error: [Semantical Error] The annotation "@apiDefine" in class App\Controller\UserController was never imported. Did you maybe forget to add a "use" statement for this annotation?  
     Run PHPStan with --debug option and post the stack trace to:                                                                                                                                                        
     https://github.com/phpstan/phpstan/issues/new?template=Bug_report.md" cannot be ignored, use excludePaths instead.

据我了解，apidoc 不需要任何导入，但是当 phpstan 在我的文件上运行时，它不知道此注释，因此会触发错误。

我认为最好的解决方案是忽略这种错误，但它说：

cannot be ignored, use excludePaths instead.

但我想将此文件保留在 phpstan 分析中。

我该如何修复或忽略此错误？

Answer 1

我想忽略 api 文档中的注释，但这是不可能的。相反，我可以忽略 doctrine

中的注释

/**
 * @IgnoreAnnotation("apiName")
 * @IgnoreAnnotation("apiDefine")
 * @IgnoreAnnotation("apiGroup")
 * @IgnoreAnnotation("apiParam")
 * @IgnoreAnnotation("apiSuccess")
 */
class UserController extends ControllerBase

我看到的唯一缺点是需要为每个文件添加它。

class App\Controller\UserController 中的注释“@apiDefine”从未导入

The annotation "@apiDefine" in class App\Controller\UserController was never imported

php

api-doc

phpstan