Back to Php Cs Fixer

Rule ``phpdoc_var_without_name``

doc/rules/phpdoc/phpdoc_var_without_name.rst

3.95.11.1 KB
Original Source

================================ Rule phpdoc_var_without_name

@var and @type annotations of classy properties should not contain the name.

Examples

Example #1


.. code-block:: diff

   --- Original
   +++ New
    <?php
    final class Foo
    {
        /**
   -     * @var int $bar
   +     * @var int
         */
        public $bar;

        /**
   -     * @type $baz float
   +     * @type float
         */
        public $baz;
    }

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\\PhpdocVarWithoutNameFixer <./../../../src/Fixer/Phpdoc/PhpdocVarWithoutNameFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\Phpdoc\\PhpdocVarWithoutNameFixerTest <./../../../tests/Fixer/Phpdoc/PhpdocVarWithoutNameFixerTest.php>`_

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