Fix PHP Fatal error in Squiz.Commenting.FunctionComment

[fredden]

Today I have seen an invalid @param tag in a docblock, and Squiz.Commenting.FunctionComment returned a PHP Fatal error while parsing the file. The error was:

There was 1 error:

1) PHP_CodeSniffer\Standards\Squiz\Tests\Commenting\FunctionCommentUnitTest::testSniff
Uninitialized string offset 0

/path/to/squizlabs-php-codesniffer/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php:413
/path/to/squizlabs-php-codesniffer/src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php:152
/path/to/squizlabs-php-codesniffer/src/Files/File.php:498
/path/to/squizlabs-php-codesniffer/src/Files/LocalFile.php:92
/path/to/squizlabs-php-codesniffer/tests/Standards/AbstractSniffUnitTest.php:173
/path/to/squizlabs-php-codesniffer/tests/TestSuite7.php:28

I have tracked this down, added a test case to cover this, and fixed the bug.

Update 2023-06-08: by fixing the bug with a different technique (as suggested by @jrfnl on a call - thanks!), the sniff now complains about this case correctly and can auto-fix it.

[jrfnl]

Reviewed & tested. All good ✅

[jrfnl]

FYI: this fix is included in today's PHP_CodeSniffer 3.8.0 release.

As per #3932, development on PHP_CodeSniffer will continue in the PHPCSStandards/PHP_CodeSniffer repository. If you want to stay informed, you may want to start "watching" that repo (or watching releases from that repo).