phpdoc_to_comment.rst

Rule phpdoc_to_comment

Docblocks should only be used on structural elements.

Examples

Example #1

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

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

Rule sets

The rule is part of the following rule sets:

@PhpCsFixer

Using the @PhpCsFixer rule set will enable the phpdoc_to_comment rule.

@Symfony

Using the @Symfony rule set will enable the phpdoc_to_comment rule.