-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Require constructor property promotion #283
Conversation
@@ -25,20 +25,10 @@ class Example implements IteratorAggregate | |||
{ | |||
private const VERSION = PHP_VERSION - (PHP_MINOR_VERSION * 100) - PHP_PATCH_VERSION; | |||
|
|||
private int|null $foo = null; | |||
|
|||
/** @var string[] */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This comment is lost. Should I report a bug about it? I've tried adding an @param
phpdoc to the constructor, and it stays.
In your projects, when you use CPP, do you use @param
, or do you annotate properties, like this:
public function __construct(
/** @var list<string> */
private array $someProperty,
…
) {
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I use the following:
/** @param list<EntitySlot> $slots */
public function __construct(
private readonly array $slots,
) {
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as @morozov
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@greg0ire I can add some options to the sniff if needed (in August).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think, this is fine. We have other sniffs plus static analysis in place that should already complain about the missing @param
annotation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There seems to be an agreement. What should I do then? Use @param
in tests/fixed/example-class.php
and fix the patches so that they apply cleanly? Or just keep as is so that this disappearance stays documented?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or just keep as is so that this disappearance stays documented?
Keeping it as it is, is fine I guess.
880a095
to
e0b40d9
Compare
I need to add more tests and to update the patches, but let's first examine together what happens on existing code and what to do about that.