Fix @type to @var
#186
Fix @type to @var
#186
Conversation
- vfsStreamFile allows any FileContent to be used as the file, however the interface is missing these methods so not every implementation of FileContent would be acceptable. - All existing implementations contain these methods.
| */ | ||
| protected $exclusiveLock; | ||
| /** | ||
| * Resources ids which currently holds shared lock to this file | ||
| * | ||
| * @type bool[string] | ||
| * @var array<string, bool> |
There was a problem hiding this comment.
Is this valid PHPDoc? I have never seen this style used before with any PHP documentation parser/generator.
I would think bool[]|string[]. If you wanted more accuracy, (bool|string)[]. This form is from the PSR-5 draft and isn't widely supported yet though.
There was a problem hiding this comment.
It's actually a bool[] indexed by string. The doc format is PHP Generics, which is still just an RFC but is what phpstan uses to add more detail to known data structures. It's essentially a <key, value> comment, in this case. Generics can be used for a lot more than that. There's big projects that have some usage of it, but not a lot.
Documenting it using the generics syntax will help static analysis tools ensure data quality, as it should trigger an error if someone ever tries to use a non-string as an index in that array.
Alternatively, it could be @var bool[] Indexed by string but it'll be a little less helpful for static analysis.
There was a problem hiding this comment.
Ah I see! I knew about the Generics syntax, but didn't realize you could apply it to array.
There was a problem hiding this comment.
And yes this is a valid phpdoc, we introduced that I think about 4 years ago ;-)
|
Uhm... a little late to the party, but the methods which switched from |
@typewith@var@typeis not a valid phpdoc tag.@varhelps static analysis tools identify what properties should contain.@deprecatedto@apibased on this discussion