Allow more commenting in BlankLineBeforeReturnSniff (#207)

closes GH-203

Author: mmoll

Symfony/Sniffs/Formatting/BlankLineBeforeReturnSniff.php

@@ -69,8 +69,12 @@ public function process(File $phpcsFile, $stackPtr)
         $spaceTokens     = [
             'T_WHITESPACE',
             'T_COMMENT',
+            'T_DOC_COMMENT_OPEN_TAG',
             'T_DOC_COMMENT_CLOSE_TAG',
+            'T_DOC_COMMENT_TAG',
+            'T_DOC_COMMENT_STRING',
             'T_DOC_COMMENT_WHITESPACE',
+            'T_PHPCS_IGNORE',
         ];
 
         while ($current >= 0 && $tokens[$current]['line'] >= $previousLine) {

Symfony/Tests/Formatting/BlankLineBeforeReturnUnitTest.inc

@@ -37,6 +37,30 @@ function invalidFunctionReturnOne()
     return;
 }
 
+function validFunctionReturnWithPhpcsIgnore1(): string
+{
+    // phpcs:ignore Foobar.Whatever.Rule
+    return foobar(1);
+}
+
+function validFunctionReturnWithPhpcsIgnore2(): string
+{
+    /* phpcs:ignore Foobar.Whatever.Rule */
+    return foobar(1);
+}
+
+function validFunctionReturnWithPhpcsIgnore3(): string
+{
+    /** phpcs:ignore Foobar.Whatever.Rule */
+    return foobar(1);
+}
+
+function validFunctionReturnWithVariableDoc(): string
+{
+    /** @psalm-var ClassName $variable */
+    return foobar(1);
+}
+
 switch ($condition) {
     case 'foo':
         return true;

Symfony/Tests/Formatting/BlankLineBeforeReturnUnitTest.inc.fixed

@@ -38,6 +38,30 @@ function invalidFunctionReturnOne()
     return;
 }
 
+function validFunctionReturnWithPhpcsIgnore1(): string
+{
+    // phpcs:ignore Foobar.Whatever.Rule
+    return foobar(1);
+}
+
+function validFunctionReturnWithPhpcsIgnore2(): string
+{
+    /* phpcs:ignore Foobar.Whatever.Rule */
+    return foobar(1);
+}
+
+function validFunctionReturnWithPhpcsIgnore3(): string
+{
+    /** phpcs:ignore Foobar.Whatever.Rule */
+    return foobar(1);
+}
+
+function validFunctionReturnWithVariableDoc(): string
+{
+    /** @psalm-var ClassName $variable */
+    return foobar(1);
+}
+
 switch ($condition) {
     case 'foo':
         return true;