• Install now

Rule phpdoc_tag_casing

Fixes casing of PHPDoc tags.

Configuration

tags

List of tags to fix with their expected casing.

Allowed types: list<string>

Default value: ['inheritDoc']

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 /**
- * @inheritdoc
+ * @inheritDoc
  */

Example #2

With configuration: ['tags' => ['foo']].

--- Original
+++ New
 <?php
 /**
  * @inheritdoc
- * @Foo
+ * @foo
  */

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocTagCasingFixer

• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocTagCasingFixerTest

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