magecom/php-docblock-checker

一个用于检查PHP类和方法是否正确使用docblocks的简单工具。

维护者

详细信息

github.com/magecom/php-docblock-checker

主页

源代码

问题

安装次数: 7,009

依赖项: 0

建议: 0

安全性: 0

星星: 0

关注者: 1

分支: 38

1.10.7 2021-01-15 10:42 UTC

Requires

Requires (Dev)

BSD-2-Clause 798de3c5350da6c998026697395a81189cb3d4a4

phpcommenttestingdocblockphpcicheckercode quality

This package is auto-updated.

Last update: 2024-09-15 18:14:27 UTC

README

检查目录内PHP文件的Docblocks使用是否适当。

安装

Composer:
composer require block8/php-docblock-checker

用法

CMD:
调用 vendor/bin/phpdoccheck {参数}

验证上次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选项来覆盖配置文件的位置

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

每个选项也可以在配置文件中找到

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