ContextQMD
Back to Php Cs Fixer

Rule ``multiline_comment_opening_closing``

doc/rules/comment/multiline_comment_opening_closing.rst

3.95.11.2 KB
Original Source

========================================== Rule multiline_comment_opening_closing

DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash.

Examples

Example #1


.. code-block:: diff

   --- Original
   +++ New
    <?php

   -/******
   +/*
     * Multiline comment with arbitrary asterisks count
   - ******/
   + */

   -/**\
   +/*\
     * Multiline comment that seems a DocBlock
     */

    /**
     * DocBlock with arbitrary asterisk count at the end
   - **/
   + */

Rule sets
---------

The rule is part of the following rule set:

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

References
----------

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

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