PHP-CS-Fixer/doc/rules/phpdoc/phpdoc_param_order.rst

===========================
Rule ``phpdoc_param_order``
===========================

Orders all ``@param`` annotations in DocBlocks according to method signature.

Examples
--------

Example #1
~~~~~~~~~~

.. code-block:: diff

   --- Original
   +++ New
    <?php
    /**
     * Annotations in wrong order
     *
     * @param int   $a
   + * @param array $b
     * @param Foo   $c
   - * @param array $b
     */
    function m($a, array $b, Foo $c) {}
References
----------

- Fixer class: `PhpCsFixer\\Fixer\\Phpdoc\\PhpdocParamOrderFixer <./../../../src/Fixer/Phpdoc/PhpdocParamOrderFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\Phpdoc\\PhpdocParamOrderFixerTest <./../../../tests/Fixer/Phpdoc/PhpdocParamOrderFixerTest.php>`_

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