no_empty_comment.rst 825 B

123456789101112131415161718192021222324252627282930313233343536373839
  1. =========================
  2. Rule ``no_empty_comment``
  3. =========================
  4. There should not be any empty comments.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. <?php
  13. -//
  14. -#
  15. -/* */
  16. +
  17. +
  18. +
  19. Rule sets
  20. ---------
  21. The rule is part of the following rule sets:
  22. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  23. - `@Symfony <./../../ruleSets/Symfony.rst>`_
  24. References
  25. ----------
  26. - Fixer class: `PhpCsFixer\\Fixer\\Comment\\NoEmptyCommentFixer <./../../../src/Fixer/Comment/NoEmptyCommentFixer.php>`_
  27. - Test class: `PhpCsFixer\\Tests\\Fixer\\Comment\\NoEmptyCommentFixerTest <./../../../tests/Fixer/Comment/NoEmptyCommentFixerTest.php>`_
  28. The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.