magento/magento-coding-standard

Do not require DocBlock for typed class attributes

aligent-lturner opened this issue · 1 comments

aligent-lturner commented

Description

Do not require a DocBlock for typed class attributes

Expected behavior

Class attributes that have specified types should not require a DocBlock. When an attribute already has a type, the DocBlock is providing no new information, and is instead just creating noise - e.g.:

/** @var ProductRepositoryInterface */
private ProductRepositoryInterface $productRepository;

We already have the type information - we don't need the DocBlock to tell us the type.

I propose that the rule regarding class attributes requiring a @var annotation with a type be changed so that it only applies to attributes without a specified type.

Benefits

Removes the need for redundant comments

m2-assistant commented

Hi @aligent-lturner. 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