Phpinspectionsea: Redudant @var/@type/@param

[rentalhost]

Description (screenshot):

PS supports "redundant suppression". I think a good idea supports "redundant @var" and similar. For instance, if a method always returns User|null, so @var User|null is redundant.

Example

function getUser(): ?User { ... }

/** @var User|null $user redundant! */
$user = getUser();

/** @var User $user allowed */
$user = getUser();

[funivan]

I wrote simple plugin which contains this feature https://github.com/funivan/phpclean#redundantdoccommenttag
You can test it already.

It can be simply implemented in this repository if needed.

[orklah]

I wrote simple plugin which contains this feature https://github.com/funivan/phpclean#redundantdoccommenttag
You can test it already.

It can be simply implemented in this repository if needed.

Would it be possible to implement the same thing but for @var related to variables in code? IIRC, your inspection flag only the doc blocks related to functions, methods or attributes.

[funivan]

@orklah So you write var for the variable and want to remove it?

[orklah]

Yeah. It happens a lot, you write a @var because the IDE doesn't resolve a type, but later you add a type somewhere else(in a return hint for example) and the @var become useless.

For example, I used your VirtualTypeCheck inspection to remove a lot of @var that were redundant in my code.

[kalessil]

@funivan, check your link - looks pretty much the same pattern. Can you incorporate this into your plugin, please?

[kalessil]

If yes, feel free to close this ticket.

[funivan]

Sorry for the delay.
I have created an issue in the PhpClean repository.

[kalessil]

No worries, thank you!

[orklah]

FYI, Issue was implemented in PhpStorm 2020.1