-
Notifications
You must be signed in to change notification settings - Fork 379
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 PHP File-Level DocBlocks Globally #791
Conversation
I wonder if it's worth tagging with phpdoc annotations (@license and co)? |
Personally, I don't see too much value in adding more lines (and effective wasted horizontal space) to the header comment. I think we should keep it as simple as possible. For example, one or the other, but not both, would be my preference:
or
|
I see your point, maybe the former is the better option as I see it's a common standard elsewhere - in which case lgtm! 👍 |
@lsmith77 Do you have a format preference for the file-level doc-block? Or is the submitted doc-block okaty? |
59c1856
to
6c66add
Compare
fine for me .. |
@lsmith77 This is going to become quite a pain to merge as files are updated/removed/added, so I'm not going to constantly re-base it as other changes are merged. Instead, just give me a shout whenever you decide to merge this if it needs a re-base and I'll handle it once, right away. |
Add the following doc-block to all PHP files in this project:
This has been my file-level doc-block style of choice for quite some time (some may notice it is directly modeled after Symfony's).
That being said, I am more than open to alterations if the consensus suggests one.