[PSR-12] Proposal for a @generated tag

[Enrico Zimuel]

Hi,

While working with generated PHP files, I noticed we don't have a specific phpDoc tag to inform us that a file/class/function has been generated.

Right now, I'm using a simple comment like this: https://github.com/elastic/elasticsearch-php/blob/master/src/Elasticsearch/Endpoints/Count.php#L25

This information is really important because the generated file should not be edited manually:-)

My proposal is to add a @generated tag for PSR-12 as follows:

/**

 * @generated using util/GenerateEndpoints.php script

 */

What do you think?

Thanks!

Regards,

Enrico Zimuel

https://zimuel.it

[Alexander Makarov]

That sounds like a candidate for PSR-5, not for PSR-12.

[Chuck Burgess]

PSR-19 actually... that's the tag catalog.

CRB

--
You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to php-fig+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/6d0cbf93-e8e4-4447-83b2-03f5d456a1can%40googlegroups.com.

[Enrico Zimuel]

Hi Chuck,

That's true, the proposal is for PSR-19.

Thanks!

Regards,

Enrico

To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/CANsgjnuUQwyftPg5t9C7%3DRMP-T9oggd0KcON7CRRLidLPz3DOw%40mail.gmail.com.

[Enrico Zimuel]

Hi Chuck,

I just sent this PR https://github.com/php-fig/fig-standards/pull/1249 proposing the @generated tag for PSR-19.

Regards,

Enrico