[Contributing] [Standards] Added note about phpdoc_separation #5446
Conversation
phansys
commented
Jun 26, 2015
phansys
commented
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | no |
| Applies to | 2.8+ |
| Fixed tickets |
| Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | 2.8+ | Fixed tickets |
| @@ -172,6 +172,10 @@ Documentation | |||
|
|
|||
| * Add PHPDoc blocks for all classes, methods, and functions; | |||
|
|
|||
| * Group annotations together so that annotations of the same type immediately | |||
There was a problem hiding this comment.
I think this proposal makes sense ... but in some cases it can be difficult to decide the annotation type. @ORM and @Assert obviously define their own groups, but what about @Cache, @Method, @Route, @Security Are these four annotations of the same type?
There was a problem hiding this comment.
this rule is in the "Documentation" section. This means it's focused on the PHPdoc annotations
There was a problem hiding this comment.
I see. But my question remains ... what is an "annotation type"?
There was a problem hiding this comment.
@param, @return, @throws, @author are all different types. Just different annotations
There was a problem hiding this comment.
OK. I finally understood it. So maybe we could say something like "group annotations by name"?
There was a problem hiding this comment.
I just copied the text from php-cs-fixer:
phpdoc_separation [symfony]
Annotations in phpdocs should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line.
|
My idea is to document all the rules tagged as [symfony] in php-cs-fixer within separated PRs and later add a note about the possibility of running the tool with |
|
👍 for merging this PR! |
|
I agree with @wouterj: this PR looks mergeable. Please forget my comment above. |
…tion (phansys) This PR was submitted for the 2.8 branch but it was merged into the 2.3 branch instead (closes #5446). Discussion ---------- [Contributing] [Standards] Added note about phpdoc_separation | Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | 2.8+ | Fixed tickets | Commits ------- fd7c335 [Contributing] [Standards] Added note about phpdoc_separation.
|
Thank you very much for this nice improvement @phansys and sorry for the delay. I merged this into the |
