Skip to content
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

Add @author tags to generated docblocks. #129

Open
aubreypwd opened this issue Feb 18, 2017 · 3 comments
Open

Add @author tags to generated docblocks. #129

aubreypwd opened this issue Feb 18, 2017 · 3 comments

Comments

@aubreypwd
Copy link
Contributor

aubreypwd commented Feb 18, 2017

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.

@binarygary
Copy link
Contributor

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
Copy link
Contributor

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.

@aubreypwd aubreypwd removed their assignment Sep 29, 2017
@aubreypwd
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants