使用 PHPDoc 仅查找错误


Use PHPDoc to find errors only

如何在不生成完整文档的情况下运行 PHPDoc 获取错误列表?

我正在尝试为我的 IDE 编写一个插件,该插件根据 PHPDoc 生成的错误验证文件。但是,我不需要它来经历制作文档的麻烦。

我找不到phpdoc的选项。或者,我可以使用 PHPCodeSniffer 来嗅探我们的这些违规行为。phpdoc 的规则是否以嗅探器形式提供?

示例错误(我意识到其中一些已经可以作为嗅探,但希望它们在一个地方):

  • 没有类My_Class的简短描述
  • 参数 $input 在 myMethod() 的文档块中缺失

根据 phpdoc.org,您可以使用以下命令生成错误清单:

$ phpdoc -d [SOURCE] -t [TARGET] --template checkstyle

该链接还提供了几种执行此操作的替代方法。