Rule `no_break_comment`¶

There must be a comment when fall-through is intentional in a non-empty case body.

Description¶

Adds a “no break” comment before fall-through cases, and removes it if there is no fall-through.

The text to use in the added comment and to detect it.

Allowed types: string

Default value: 'no break'

Default configuration.

--- Original
+++ New
 <?php
 switch ($foo) {
     case 1:
         foo();
+        // no break
     case 2:
         bar();
-        // no break
         break;
     case 3:
         baz();
 }

With configuration: ['comment_text' => 'some comment'].

--- Original
+++ New
 <?php
 switch ($foo) {
     case 1:
         foo();
+        // some comment
     case 2:
         foo();
 }

The rule is part of the following rule sets:

@PER: Using the @PER rule set will enable the no_break_comment rule with the default config.
@PSR2: Using the @PSR2 rule set will enable the no_break_comment rule with the default config.
@PSR12: Using the @PSR12 rule set will enable the no_break_comment rule with the default config.
@PhpCsFixer: Using the @PhpCsFixer rule set will enable the no_break_comment rule with the default config.
@Symfony: Using the @Symfony rule set will enable the no_break_comment rule with the default config.