Back to Php Cs Fixer

Rule ``phpdoc_no_useless_inheritdoc``

doc/rules/phpdoc/phpdoc_no_useless_inheritdoc.rst

3.95.11.1 KB
Original Source

===================================== Rule phpdoc_no_useless_inheritdoc

Classy that does not inherit must not have @inheritdoc tags.

Examples

Example #1


.. code-block:: diff

   --- Original
   +++ New
    <?php
   -/** {@inheritdoc} */
   +/** */
    class Sample
    {
    }

Example #2

.. code-block:: diff

--- Original +++ New <?php class Sample { /**

  • * @inheritdoc
    
  • * 
    */
    
    public function Test() { } }

Rule sets

The rule is part of the following rule sets:

  • @PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>_
  • @Symfony <./../../ruleSets/Symfony.rst>_

References

  • Fixer class: PhpCsFixer\\Fixer\\Phpdoc\\PhpdocNoUselessInheritdocFixer <./../../../src/Fixer/Phpdoc/PhpdocNoUselessInheritdocFixer.php>_
  • Test class: PhpCsFixer\\Tests\\Fixer\\Phpdoc\\PhpdocNoUselessInheritdocFixerTest <./../../../tests/Fixer/Phpdoc/PhpdocNoUselessInheritdocFixerTest.php>_

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