generator-plugin-wp icon indicating copy to clipboard operation
generator-plugin-wp copied to clipboard

Add @author tags to generated docblocks.

Open aubreypwd opened this issue 8 years ago • 3 comments

The person who generates the plugin leaves a lot of functions w/out any @author tags, when technically they were the author of the scaffolded classes, etc. We could automatically add @author <%= author %> to the docblocks of all generated content.

The reason I bring this up is because, when creating my own plugins (non WDS Client), All docblocks don't have an @author Aubrey Portwood and I have to add them all manually. Technically, since I ran the generator, I am the author of all the code for that project.

Would love to get feedback on this before I do it.

aubreypwd avatar Feb 18 '17 17:02 aubreypwd

I'm for the idea of adding the @author tag.
Is there also benefit in including a note that these methods were scaffolded? If so I propose we use the @author and include @see that explains this method was originally generated and potentially modified by https://github.com/WebDevStudios/generator-plugin-wp/ or something to that effect. Thoughts?

binarygary avatar Feb 19 '17 01:02 binarygary

I'm going to change my opinion on @author after reading Clean Code (again). Most (all?) use of the plugin gen will be version controlled. Using git blame will yield a more accurate indication of who wrote, and more importantly, refactored something.

binarygary avatar Jul 20 '17 01:07 binarygary

If @author ever makes it into WDS-Coding-Standards, I'd be happy to do this. But, with it's debatable nature, we have to wait.

aubreypwd avatar Sep 29 '17 16:09 aubreypwd