php - 使用 PHPDoc 仅查找错误

标签 php phpdoc

如何运行 PHPDoc 来获取错误列表而不生成完整文档?

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

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

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

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

最佳答案

According to phpdoc.org ,您可以使用以下命令生成错误 list :

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

That link还提供了几种实现此目的的替代方法。

关于php - 使用 PHPDoc 仅查找错误,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/10726451/

相关文章:

php - 可迭代对象的正确 phpdoc 注释?

phpDocumentor 替代消耗更少的内存

phpDocumentor 制表符分隔符

php - 通过 SDK 检索 Paypal 计划给出错误代码 400 - 无请求负载

php - 在 isset() 之后将值添加到数组

php - 在 PhpStorm 中标记 @see

php - 如何在类定义之外为魔术属性创建 PHPDoc?

php - 在 MySQL 中使用唯一引用作为主键

php - 是否可以在PHP中将WAV文件转换为AIFF,反之亦然?

php - 如何在单个查询中获取两个单独的错误结果