包简介

A simple tool for checking that your PHP classes and methods use docblocks.

README 文档

README

Check PHP files within a directory for appropriate use of Docblocks. This is a fork of the original work from @dancryer but just adding support for newer php features

Installation

Composer

composer require neild3r/php-docblock-checker

Usage

CMD

call vendor/bin/phpdoccheck {params}

To validate changed files in the last git commit:

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

If used within a travis context, this may be useful:

git diff --name-only ${TRAVIS_COMMIT_RANGE:-"HEAD^"} | ./vendor/bin/phpdoccheck --from-stdin

Parameters

Parameters may be passed either from the command line, or via a config file (defaults to phpdoccheck.yml in the currrent working directory).

The config file location may be overriden by specifying the --config-file option

If a parameter is specified in both places, the command line will take priority.

Short	Long	Description
-h	--help	Display help message.
-x	--exclude=EXCLUDE	Files and directories (absolute or pattern) to exclude.
-d	--directory=DIRECTORY	Directory to scan. [default: "./"]
none	--cache-file=FILE	Use cache file to speed up processing.
none	--config-file=FILE	Use config file to specify options [default: "./phpdoccheck.yml"].
none	--from-stdin	Use list of files provided via stdin
none	--skip-classes	Don't check classes for docblocks.
none	--skip-methods	Don't check methods for docblocks.
none	--skip-signatures	Don't check docblocks against method signatures.
none	--only-signatures	Only check methods that have parameters or returns.
-j	--json	Output JSON instead of a log.
-l	--files-per-line=FILES-PER-LINE	Number of files per line in progress [default: 50]
-w	--fail-on-warnings	Consider the check failed if any warnings are produced.
-i	--info-only	Information-only mode, just show summary.
-q	--quiet	Do not output any message.
-V	--version	Display this application version.
none	--ansi	Force ANSI output.
none	--no-ansi	Disable ANSI output.
-n	--no-interaction	Do not ask any interactive question.
-v -vv -vvv	--verbose	Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.

Each option is also available in the 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

neild3r/php-docblock-checker 适用场景与选型建议

neild3r/php-docblock-checker 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 165.53k 次下载、GitHub Stars 达 0，最近一次更新时间为 2023 年 09 月 07 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「comment」「testing」「docblock」「phpci」「checker」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 neild3r/php-docblock-checker 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 neild3r/php-docblock-checker 我们能提供哪些服务？

定制开发 / 二次开发

基于 neild3r/php-docblock-checker 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发