phpdoc_to_comment.rst

Rule phpdoc_to_comment

Docblocks should only be used on structural elements.

Configuration

allow_before_return_statement

Whether to allow PHPDoc before return statement.

Allowed types: bool

Default value: false

ignored_tags

List of ignored tags (matched case insensitively).

Allowed types: list<string>

Default value: []

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 $first = true;// needed because by default first docblock is never fixed.

-/** This should be a comment */
+/* This should be a comment */
 foreach($connections as $key => $sqlite) {
     $sqlite->open($path);
 }

Example #2

With configuration: ['ignored_tags' => ['todo']].

--- Original
+++ New
 <?php
 $first = true;// needed because by default first docblock is never fixed.

-/** This should be a comment */
+/* This should be a comment */
 foreach($connections as $key => $sqlite) {
     $sqlite->open($path);
 }

 /** @todo This should be a PHPDoc as the tag is on "ignored_tags" list */
 foreach($connections as $key => $sqlite) {
     $sqlite->open($path);
 }

Example #3

With configuration: ['allow_before_return_statement' => true].

--- Original
+++ New
 <?php
 $first = true;// needed because by default first docblock is never fixed.

-/** This should be a comment */
+/* This should be a comment */
 foreach($connections as $key => $sqlite) {
     $sqlite->open($path);
 }

 function returnClassName() {
     /** @var class-string */
     return \StdClass::class;
 }

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer
• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocToCommentFixerTest

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