PHPackages bilberrry/php-docblock-checker - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Testing & Quality](/categories/testing) 4. / 5. bilberrry/php-docblock-checker ActiveLibrary[Testing & Quality](/categories/testing) bilberrry/php-docblock-checker ============================== A simple tool for checking that your PHP classes and methods use docblocks. 1.10.3(6y ago)01.4k1BSD-2-ClausePHPPHP >=5.5 Since May 8Pushed 6y agoCompare [ Source](https://github.com/bilberrry/php-docblock-checker)[ Packagist](https://packagist.org/packages/bilberrry/php-docblock-checker)[ Docs](https://www.phptesting.org/)[ RSS](/packages/bilberrry-php-docblock-checker/feed)WikiDiscussions master Synced yesterday READMEChangelogDependencies (8)Versions (23)Used By (0) PHP DocBlock Checker ==================== [](#php-docblock-checker) Check PHP files within a directory for appropriate use of Docblocks. Installation ------------ [](#installation) **Composer**: `composer require bilberrry/php-docblock-checker` Usage ----- [](#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) 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. ShortLongDescription-h--helpDisplay help message.-x--exclude=EXCLUDEFiles and directories (absolute or pattern) to exclude.-d--directory=DIRECTORYDirectory to scan. \[default: "./"\]none--cache-file=FILEUse cache file to speed up processing.none--config-file=FILEUse config file to specify options \[default: "./phpdoccheck.yml"\].none--from-stdinUse list of files provided via stdinnone--skip-classesDon't check classes for docblocks.none--skip-methodsDon't check methods for docblocks.none--skip-signaturesDon't check docblocks against method signatures.none--only-signaturesOnly check methods that have parameters or returns.-j--jsonOutput JSON instead of a log.-l--files-per-line=FILES-PER-LINENumber of files per line in progress \[default: 50\]-w--fail-on-warningsConsider the check failed if any warnings are produced.-i--info-onlyInformation-only mode, just show summary.-q--quietDo not output any message.-V--versionDisplay this application version.none--ansiForce ANSI output.none--no-ansiDisable ANSI output.-n--no-interactionDo not ask any interactive question.-v -vv -vvv--verboseIncrease 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 ``` ### Health Score 32 — LowBetter than 72% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community15 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~100 days Recently: every ~79 days Total 22 Last Release 2289d ago PHP version history (3 changes)1.0.0PHP >=5.3.3 1.5.0PHP >=5.4 1.10.0PHP >=5.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/c156cf7b4e2caeb8a58ce7fce16e48b39ee9338c0c5d4e24e9473ab74bce0fda?d=identicon)[bilberrry](/maintainers/bilberrry) --- Top Contributors [![philwc](https://avatars.githubusercontent.com/u/617110?v=4)](https://github.com/philwc "philwc (24 commits)")[![dancryer](https://avatars.githubusercontent.com/u/35393?v=4)](https://github.com/dancryer "dancryer (14 commits)")[![kuzimovich8](https://avatars.githubusercontent.com/u/24361547?v=4)](https://github.com/kuzimovich8 "kuzimovich8 (3 commits)")[![tomsowerby](https://avatars.githubusercontent.com/u/1676069?v=4)](https://github.com/tomsowerby "tomsowerby (3 commits)")[![TekkCraft](https://avatars.githubusercontent.com/u/21214298?v=4)](https://github.com/TekkCraft "TekkCraft (1 commits)")[![kkarkus](https://avatars.githubusercontent.com/u/17312072?v=4)](https://github.com/kkarkus "kkarkus (1 commits)")[![charliemcratgear4music](https://avatars.githubusercontent.com/u/42539818?v=4)](https://github.com/charliemcratgear4music "charliemcratgear4music (1 commits)")[![jfi](https://avatars.githubusercontent.com/u/663625?v=4)](https://github.com/jfi "jfi (1 commits)")[![ataylor-g4m](https://avatars.githubusercontent.com/u/37832818?v=4)](https://github.com/ataylor-g4m "ataylor-g4m (1 commits)") --- Tags phptestingdocblockcode qualitycommentcheckerphpci ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/bilberrry-php-docblock-checker/health.svg) ``` [![Health](https://phpackages.com/badges/bilberrry-php-docblock-checker/health.svg)](https://phpackages.com/packages/bilberrry-php-docblock-checker) ``` ### Alternatives [behat/behat Scenario-oriented BDD framework for PHP 4.0k96.8M2.0k](/packages/behat-behat)[vimeo/psalm A static analysis tool for finding errors in PHP applications 5.8k77.5M6.7k](/packages/vimeo-psalm)[php-censor/phpdoc-checker A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork). 1374.1k2](/packages/php-censor-phpdoc-checker)[infection/infection Infection is a Mutation Testing framework for PHP. The mutation adequacy score can be used to measure the effectiveness of a test set in terms of its ability to detect faults. 2.2k26.2M1.8k](/packages/infection-infection)[magento/magento2-functional-testing-framework Magento2 Functional Testing Framework 15511.5M30](/packages/magento-magento2-functional-testing-framework)[acquia/orca A tool for testing a company's software packages together in the context of a realistic, functioning, best practices Drupal build 32902.4k](/packages/acquia-orca) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)