feat(FunctionComment): Docblock is not required for __constuct() meth…

…ods (#3400560)
pfrenssen · Jan 27, 2024 · 0f95abc · 0f95abc
1 parent ba6e623
commit 0f95abc
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php
@@ -93,6 +93,16 @@ public function process(File $phpcsFile, $stackPtr)
             break;
         }
 
+        // Constructor methods are exempt from requiring a docblock.
+        // @see https://www.drupal.org/project/coder/issues/3400560.
+        $methodName = $phpcsFile->getDeclarationName($stackPtr);
+        if ($methodName === '__construct'
+            && $tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
+            && $tokens[$commentEnd]['code'] !== T_COMMENT
+        ) {
+            return;
+        }
+
         $beforeCommentEnd = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($commentEnd - 1), null, true);
         if (($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
             && $tokens[$commentEnd]['code'] !== T_COMMENT)

diff --git a/tests/Drupal/Commenting/FunctionCommentUnitTest.inc b/tests/Drupal/Commenting/FunctionCommentUnitTest.inc
@@ -947,4 +947,14 @@ class Test3 {
     return [];
   }
 
+}
+
+/**
+ * Test that docblock is optional for __construct methods.
+ */
+class Test43 {
+
+  public function __construct() {
+  }
+
 }
diff --git a/tests/Drupal/Commenting/FunctionCommentUnitTest.inc.fixed b/tests/Drupal/Commenting/FunctionCommentUnitTest.inc.fixed
@@ -974,3 +974,13 @@ class Test3 {
   }
 
 }
+
+/**
+ * Test that docblock is optional for __construct methods.
+ */
+class Test43 {
+
+  public function __construct() {
+  }
+
+}