phpdoc_single_line_var_spacing.rst 967 B

1234567891011121314151617181920212223242526272829303132333435
  1. =======================================
  2. Rule ``phpdoc_single_line_var_spacing``
  3. =======================================
  4. Single line ``@var`` PHPDoc should have proper spacing.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. -<?php /**@var MyClass $a */
  13. +<?php /** @var MyClass $a */
  14. $a = test();
  15. Rule sets
  16. ---------
  17. The rule is part of the following rule sets:
  18. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  19. - `@Symfony <./../../ruleSets/Symfony.rst>`_
  20. References
  21. ----------
  22. - Fixer class: `PhpCsFixer\\Fixer\\Phpdoc\\PhpdocSingleLineVarSpacingFixer <./../../../src/Fixer/Phpdoc/PhpdocSingleLineVarSpacingFixer.php>`_
  23. - Test class: `PhpCsFixer\\Tests\\Fixer\\Phpdoc\\PhpdocSingleLineVarSpacingFixerTest <./../../../tests/Fixer/Phpdoc/PhpdocSingleLineVarSpacingFixerTest.php>`_
  24. The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.