phpdoc_trim.rst

Rule phpdoc_trim

PHPDoc should start and end with content, excluding the very first and last line of the docblocks.

Examples

Example #1

--- Original
+++ New
 <?php
 /**
- *
  * Foo must be final class.
- *
- *
  */
 final class Foo {}

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer
• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocTrimFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.