search

phpDocumentor / fig-standards

Standards either proposed or approved by the Framework Interop Group
http://www.php-fig.org/
Other
361 stars 85 forks source link

allow to hint "@deprecated" of a magic property #152

Closed staabm closed 5 years ago

staabm commented 7 years ago

it would be great if one could hint via phpdoc that a magic property is deprecated.

I have more or less the same use-case as described in https://stackoverflow.com/questions/37554329/how-to-deprecate-phps-magic-property-in-phpdoc#37554478

atm it is rather hard to phase out a magic property as there is no tool support for marking them as deprecated.

ashnazg commented 5 years ago

I've never been convinced that this use case needs such specialized standardization. The magic tags were added to give some minimal level of document-ability to stuff that coders did not want to just go ahead and make more explicitly coded. Thus, I'm -1 on this.

Ping @ondrejmirtes @muglug @neuro159 @mindplay-dk @GaryJones @mvriel @jaapio for opinions.

jaapio commented 5 years ago

From a code point of view I totally agree with you that magic properties an methods are not a good idea. I prefer more explicit code.

From a more practical perspective I understand the request but I don't see any solution how to add a feature like this to the current tag. It is a very simplified way of defining an property. I think it should even be a single line? So also a - 1 for me.

GaryJones commented 5 years ago

-1 also. It seems a rather rare case, for it to be standardized.

neuro159 commented 5 years ago

-1

ashnazg commented 5 years ago

Looks like a no-go.