Documentation: improve use of @internal tags#950
Merged
Conversation
For the use of `@internal` tags with comments for dev internal information, it used to be recommended to use `{@internal ... }}` (not the double curlies at the end) format to help IDEs parse these correctly.
This format has since been superseded as the parsing of docblocks in IDEs has improved a lot since then.
The current recommendation is to just use a single curly at the end.
Ref: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#55-internal
jrfnl
added
Type: chores/QA
Type: documentation
PR: quick merge
wimg
approved these changes
Dec 26, 2019
jrfnl
removed
PR: quick merge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
For the use of
@internaltags with comments for dev internal information, it used to be recommended to use{@internal ... }}(not the double curlies at the end) format to help IDEs parse these correctly.This format has since been superseded as the parsing of docblocks in IDEs has improved a lot since then.
The current recommendation is to just use a single curly at the end.
Ref: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#55-internal