phpdoc_indent.rst 692 B

1234567891011121314151617181920212223242526272829303132333435363738
  1. ======================
  2. Rule ``phpdoc_indent``
  3. ======================
  4. Docblocks should have the same indentation as the documented subject.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. <?php
  13. class DocBlocks
  14. {
  15. -/**
  16. - * Test constants
  17. - */
  18. + /**
  19. + * Test constants
  20. + */
  21. const INDENT = 1;
  22. }
  23. Rule sets
  24. ---------
  25. The rule is part of the following rule sets:
  26. @PhpCsFixer
  27. Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``phpdoc_indent`` rule.
  28. @Symfony
  29. Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``phpdoc_indent`` rule.