PHPackages                             php-censor/phpdoc-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. php-censor/phpdoc-checker

ActiveLibrary[Testing & Quality](/categories/testing)

php-censor/phpdoc-checker
=========================

A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).

3.1.1(2y ago)1374.1k—8.9%22BSD-2-ClausePHPPHP >=7.4.0CI failing

Since Jun 30Pushed 2y ago2 watchersCompare

[ Source](https://github.com/php-censor/phpdoc-checker)[ Packagist](https://packagist.org/packages/php-censor/phpdoc-checker)[ Docs](https://github.com/php-censor/phpdoc-checker)[ RSS](/packages/php-censor-phpdoc-checker/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (10)Versions (23)Used By (2)

[![Minimum PHP version: 7.4.0](https://camo.githubusercontent.com/cebdb51196aa5a643d531051766688899c9f90e9adc94a3447bb805109a88ba0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d372e342e302532422d626c75652e7376673f6c6162656c3d504850)](https://packagist.org/packages/php-censor/phpdoc-checker)[![Actions](https://github.com/php-censor/phpdoc-checker/actions/workflows/ci.yaml/badge.svg)](https://github.com/php-censor/phpdoc-checker/actions)[![PHP Censor](https://camo.githubusercontent.com/931986a074ecc92b3ee2c89342da2c0cde3b7ba480026804ad4134bb6b7c87bb/687474703a2f2f63692e7068702d63656e736f722e696e666f2f6275696c642d7374617475732f696d6167652f31363f6272616e63683d6d6173746572266c6162656c3d50485025323043656e736f72)](http://ci.php-censor.info/build-status/view/16?branch=master)[![Codecov](https://camo.githubusercontent.com/fba940c44744e77e017bd503adcd4d4b3e0e09b8f874c5423971a95b52fe469e/68747470733a2f2f636f6465636f762e696f2f67682f7068702d63656e736f722f706870646f632d636865636b65722f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/php-censor/phpdoc-checker)[![Latest Version](https://camo.githubusercontent.com/666d2fba8fda5bbcfcea792b4e50dc7d9af5276eb73ba3b9660b6deca4f1f1c9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7068702d63656e736f722f706870646f632d636865636b65722e7376673f6c6162656c3d56657273696f6e)](https://packagist.org/packages/php-censor/phpdoc-checker)[![Total downloads](https://camo.githubusercontent.com/0f0beeca1f5019be49d69ee7e9839af03c8242d0f03f4a09f98e0dcc9d1dc965/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7068702d63656e736f722f706870646f632d636865636b65722e7376673f6c6162656c3d446f776e6c6f616473)](https://packagist.org/packages/php-censor/phpdoc-checker)[![License](https://camo.githubusercontent.com/94af0da8d9ba335e0f65a1d32a8e8de5465de1073abc6b86705607f071a8d042/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f7068702d63656e736f722f706870646f632d636865636b65722e7376673f6c6162656c3d4c6963656e7365)](https://packagist.org/packages/php-censor/phpdoc-checker)

PHPDoc Checker
==============

[](#phpdoc-checker)

Check PHP files within a directory for appropriate use of PHPDocs (Docblocks). PHPDoc Checker is fork of [PHP DocBlock Checker](https://github.com/Block8/php-docblock-checker).

Installation
------------

[](#installation)

**Composer**:

```
composer require php-censor/phpdoc-checker
```

Building Phar Package
---------------------

[](#building-phar-package)

```
box.phar compile
```

Usage
-----

[](#usage)

```
vendor/bin/phpdoc-checker {params}
```

### Parameters

[](#parameters)

ShortLongDescription-h--helpDisplay help message.-x--exclude=EXCLUDEFiles and directories to exclude.-d--directory=DIRECTORYDirectory to scan. \[default: "./"\]-f--files=FILESFiles to scan.none--skip-classesDon't check classes for docblocks.none--skip-methodsDon't check methods for docblocks.none--skip-signaturesDon't check docblocks against method signatures.-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.Unit tests
----------

[](#unit-tests)

Phpunit tests:

```
vendor/bin/phpunit --configuration=phpunit.xml.dist --coverage-text --coverage-html=tests/var/coverage
```

License
-------

[](#license)

PHPDoc Checker is open source software licensed under the [BSD-2-Clause license](LICENSE).

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 86.2% of commits — single point of failure

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 ~128 days

Recently: every ~135 days

Total

16

Last Release

955d ago

Major Versions

1.0.3 → 2.0.02019-06-08

2.0.3 → 3.0.02021-08-20

2.1.1 → 3.0.22023-10-07

PHP version history (3 changes)1.0.0PHP >=5.6.0

2.0.0PHP >=7.1.0

3.0.0PHP >=7.4.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/bb1adf7266c31bf5a467814f6b1d165c9c4dc71beec54c34fe67158c5c2a46e0?d=identicon)[Corpsee](/maintainers/Corpsee)

---

Top Contributors

[![corpsee](https://avatars.githubusercontent.com/u/1416706?v=4)](https://github.com/corpsee "corpsee (50 commits)")[![KieranFYI](https://avatars.githubusercontent.com/u/679994?v=4)](https://github.com/KieranFYI "KieranFYI (4 commits)")[![dancryer](https://avatars.githubusercontent.com/u/35393?v=4)](https://github.com/dancryer "dancryer (1 commits)")[![jfi](https://avatars.githubusercontent.com/u/663625?v=4)](https://github.com/jfi "jfi (1 commits)")[![kkarkus](https://avatars.githubusercontent.com/u/17312072?v=4)](https://github.com/kkarkus "kkarkus (1 commits)")[![TekkCraft](https://avatars.githubusercontent.com/u/21214298?v=4)](https://github.com/TekkCraft "TekkCraft (1 commits)")

---

Tags

hacktoberfestphptestingphpdocdocblockcode qualitycommentcheckerphp-censor

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/php-censor-phpdoc-checker/health.svg)

```
[![Health](https://phpackages.com/badges/php-censor-phpdoc-checker/health.svg)](https://phpackages.com/packages/php-censor-phpdoc-checker)
```

###  Alternatives

[vimeo/psalm

A static analysis tool for finding errors in PHP applications

5.8k77.5M6.7k](/packages/vimeo-psalm)[behat/behat

Scenario-oriented BDD framework for PHP

4.0k96.8M2.0k](/packages/behat-behat)[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)[laraveldaily/filacheck

Static analysis for Filament projects - detect deprecated patterns and code issues

9016.5k](/packages/laraveldaily-filacheck)[playwright-php/playwright

Modern PHP library for Playwright automation: browsing, scraping, screenshots, testing, and more.

7613.0k5](/packages/playwright-php-playwright)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)