fix(VariableComment): Allow PHP 8.2 style type declarations with parentheses in @var comments (#3395015)

Author: klausi

coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php

@@ -952,7 +952,7 @@ public static function suggestType($type)
         // Also allow some more characters for special type hints supported by
         // PHPStan:
         // https://phpstan.org/writing-php-code/phpdoc-types#basic-types .
-        $type = preg_replace('/[^a-zA-Z0-9_\\\[\]\-<> ,"\{\}\?\':\*\|\&]/', '', $type);
+        $type = preg_replace('/[^a-zA-Z0-9_\\\[\]\-<> ,"\{\}\?\':\*\|\&\(\)]/', '', $type);
 
         return $type;
 

tests/Drupal/Commenting/VariableCommentUnitTest.inc

@@ -102,4 +102,11 @@ class Test {
   // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
   public string $search_score;
 
+  /**
+   * Allow parentheses in the type declaration.
+   *
+   * @var (\Drupal\user\UserInterface&\PHPUnit\Framework\MockObject\MockObject)|null
+   */
+  protected $userMock;
+
 }

tests/Drupal/Commenting/VariableCommentUnitTest.inc.fixed

@@ -106,4 +106,11 @@ class Test {
   // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
   public string $search_score;
 
+  /**
+   * Allow parentheses in the type declaration.
+   *
+   * @var (\Drupal\user\UserInterface&\PHPUnit\Framework\MockObject\MockObject)|null
+   */
+  protected $userMock;
+
 }