general_phpdoc_annotation_remove.rst

Rule general_phpdoc_annotation_remove

Configured annotations should be omitted from PHPDoc.

Configuration

annotations

List of annotations to remove, e.g. ["author"].

Allowed types: list<string>

Default value: []

case_sensitive

Should annotations be case sensitive.

Allowed types: bool

Default value: true

Examples

Example #1

With configuration: ['annotations' => ['author']].

--- Original
+++ New
 <?php
 /**
  * @internal
- * @author John Doe
  * @AuThOr Jane Doe
  */
 function foo() {}

Example #2

With configuration: ['annotations' => ['author'], 'case_sensitive' => false].

--- Original
+++ New
 <?php
 /**
  * @internal
- * @author John Doe
- * @AuThOr Jane Doe
  */
 function foo() {}

Example #3

With configuration: ['annotations' => ['package', 'subpackage']].

--- Original
+++ New
 <?php
 /**
  * @author John Doe
- * @package ACME API
- * @subpackage Authorization
  * @version 1.0
  */
 function foo() {}

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixerTest

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