Back to Php Cs Fixer

Rule ``single_line_comment_spacing``

doc/rules/comment/single_line_comment_spacing.rst

3.95.1968 B
Original Source

==================================== Rule single_line_comment_spacing

Single-line comments must have proper spacing.

Examples

Example #1


.. code-block:: diff

   --- Original
   +++ New
    <?php
   -//comment 1
   -#comment 2
   -/*comment 3*/
   +// comment 1
   +# comment 2
   +/* comment 3 */

Rule sets
---------

The rule is part of the following rule sets:

- `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
- `@Symfony <./../../ruleSets/Symfony.rst>`_

References
----------

- Fixer class: `PhpCsFixer\\Fixer\\Comment\\SingleLineCommentSpacingFixer <./../../../src/Fixer/Comment/SingleLineCommentSpacingFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\Comment\\SingleLineCommentSpacingFixerTest <./../../../tests/Fixer/Comment/SingleLineCommentSpacingFixerTest.php>`_

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