Magento2.Commenting.ClassPropertyPHPDocFormatting throws an error when processing typed class properties

[bgorski]

Preconditions

Steps to reproduce

1. Try processing a class that has typed properties. Here's a sample:

<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\TestFramework\Store;

class StoreManager
{
    /**
     * @var \Magento\Store\Model\StoreManager
     */
    private \Magento\Store\Model\StoreManager $decoratedStoreManager;

    /**
     * Constructor
     *
     * @param \Magento\Store\Model\StoreManager $decoratedStoreManager
     */
    public function __construct(
        \Magento\Store\Model\StoreManager $decoratedStoreManager
    ) {
        $this->decoratedStoreManager = $decoratedStoreManager;
    }

    /**
     * Test
     *
     * @return null
     */
    public function test() {
        return null;
    }
}

Expected result

1. The class can be processed

Actual result

1. Processing fails with the following error:

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 1 | ERROR | An error occurred during processing; checking has been aborted. The error message was: Undefined index: comment_opener in /home/bgorski/devilbox/data/www/github-magento2-ce/htdocs/vendor/magento/magento-coding-standard/Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php on
   |       | line 71
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

This prevents phpcs from processing the class any further.

That's the token wrongly interpreted as a comment closing:

array(8) {
  ["code"]=>
  int(393)
  ["type"]=>
  string(14) "T_NS_SEPARATOR"
  ["content"]=>
  string(1) "\"
  ["line"]=>
  int(13)
  ["column"]=>
  int(33)
  ["length"]=>
  int(1)
  ["level"]=>
  int(1)
  ["conditions"]=>
  array(1) {
    [26]=>
    int(364)
  }
}

[m2-assistant]

Hi @bgorski. Thank you for your report.
To speed up processing of this issue, make sure that you provided sufficient information.

Add a comment to assign the issue: @magento I am working on this

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[barbazul]

Looks like a duplicate of #280

[bgorski]

@barbazul it's not. While typed properties cause the sniff to fail in both tickets, in there different behavior is reported, it's marked as fixed and closed.
In here, the sniff fails to process the code completely.

[sivaschenko]

Thanks for reporting @bgorski , fixed in #317