README

检查目录内PHP文件的Docblocks使用情况。

安装

Composer:
composer require dancryer/php-docblock-checker

使用方法

CMD:
call vendor/bin/phpdoccheck {params}

验证上次git提交中更改的文件

git diff --name-only HEAD HEAD^ | ./vendor/bin/phpdoccheck --from-stdin

如果在travis环境中使用，这可能很有用： git diff --name-only ${TRAVIS_COMMIT_RANGE:-"HEAD^"} | ./vendor/bin/phpdoccheck --from-stdin

参数

参数可以从命令行或配置文件（默认为当前工作目录下的phpdoccheck.yml）传递。

可以通过指定--config-file选项来覆盖配置文件的位置

如果两个地方都指定了参数，则命令行将优先。

短	长	描述
-h	--help	显示帮助信息。
-x	--exclude=EXCLUDE	要排除的文件和目录（绝对路径或模式）。
-d	--directory=DIRECTORY	要扫描的目录。[默认: "./"]
none	--cache-file=FILE	使用缓存文件以加快处理速度。
none	--config-file=FILE	使用配置文件来指定选项[默认: "./phpdoccheck.yml"]。
none	--from-stdin	使用通过stdin提供的文件列表
none	--skip-classes	不检查类是否包含文档注释。
none	--skip-methods	不检查方法是否包含文档注释。
none	--skip-signatures	不将文档注释与方法签名进行比较。
none	--only-signatures	仅检查具有参数或返回值的方法。
-j	--json	输出JSON而不是日志。
-l	--files-per-line=FILES-PER-LINE	每行进度中的文件数[默认: 50]
-w	--fail-on-warnings	如果产生任何警告，则认为检查失败。
-i	--info-only	信息模式，仅显示摘要。
-q	--quiet	不输出任何信息。
-V	--version	显示此应用程序版本。
none	--ansi	强制ANSI输出。
none	--no-ansi	禁用ANSI输出。
-n	--no-interaction	不询问任何交互式问题。
-v -vv -vvv	--verbose	增加消息的详细程度：1为正常输出，2为更详细的输出，3为调试。

每个选项也都在配置文件中可用

directory: src
files-per-line: 10
cache-file: .phpdoccheck
exclude:
  - foo/bar/baz.php
  - foo/*
options:
  - skip-classes
  - skip-methods
  - skip-signatures
  - only-signatures
  - fail-on-warnings
  - info-only
  - from-stdin
  - json

block8 / php-docblock-checker

维护者

详细信息

README

安装

使用方法

参数