php-censor/phpdoc-checker

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

3.1.1 2023-10-07 03:44 UTC

Requires

• php: >=7.4.0
• ext-ctype: *
• ext-json: *
• nikic/php-parser: ^4.12
• symfony/console: ^4.4|^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• infection/infection: ^0.25
• php-parallel-lint/php-parallel-lint: ^1.3
• phploc/phploc: ^7.0
• phpmd/phpmd: ^2.10
• phpunit/phpunit: ^9.5
• sebastian/phpcpd: ^6.0
• vimeo/psalm: ^4.16

BSD-2-Clause

• Dmitry Khomutov
• Dan Cryer

• phpdoc
• php
• comment
• testing
• docblock
• checker
• code quality
• php-censor

README

PHPDoc Checker

Check PHP files within a directory for appropriate use of PHPDocs (Docblocks). PHPDoc Checker is fork of PHP DocBlock Checker.

Installation

Composer:

composer require php-censor/phpdoc-checker

Building Phar Package

box.phar compile

Usage

vendor/bin/phpdoc-checker {params}

Parameters

Unit tests

Phpunit tests:

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

License

PHPDoc Checker is open source software licensed under the BSD-2-Clause license.