dancryer/php-docblock-checker

一个简单的工具，用于检查您的PHP类和方法是否使用了Docblocks。

维护者

详细信息

github.com/dancryer/php-docblock-checker

主页

源代码

问题

安装次数: 147,450

依赖者: 1

建议者: 0

安全: 0

星标: 32

关注者: 6

分支: 38

开放问题: 12

1.10.3 2021-05-11 10:59 UTC

Requires

Requires (Dev)

BSD-2-Clause 458e94d76e003ccf1e869f7c6ad2ec29ab38a0b8

phpcommenttestingdocblockphpcicheckercode quality

This package is auto-updated.

Last update: 2024-09-11 21:28:23 UTC

README

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

安装

Composer:
composer require dancryer/php-docblock-checker

使用方法

命令行:
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 选项来覆盖配置文件的位置

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

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

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