This repository was archived by the owner on Nov 27, 2020. It is now read-only.
Update phpDoc to make it standard compliant #571
Closed
Conversation
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
PHP Doc stipulates that for `@var` comments, the type should come first (see http://en.wikipedia.org/wiki/PHPDoc#Tags)
|
I've no idea what the convention is, but I think it is |
|
@fabpot For class properties, the property name should indeed be omitted. But when documenting variables, the name of the variable needs to be used so that tools can know what it is referring to. |
|
@stof, right I read the diff too fast, and didn't realize it was not a class property. |
fabpot
added a commit
that referenced
this pull request
Jul 22, 2013
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #571). Discussion ---------- Update phpDoc to make it standard compliant PHP Doc stipulates that for `@var` comments, the type should come first (see http://en.wikipedia.org/wiki/PHPDoc#Tags) Commits ------- 5895afb Update phpDoc to make it standard compliant
fabpot
added a commit
that referenced
this pull request
Sep 6, 2016
This PR was merged into the 2.8 branch. Discussion ---------- Change inline var PHPDoc syntax See https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var (refer to the [examples](https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#examples-21)) Related previous PR: #571 (but there was no standard for inline `@var` at the time) Commits ------- 81ee81a Change inline var PHPDoc syntax
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PHP Doc stipulates that for
@varcomments, the type should come first (see http://en.wikipedia.org/wiki/PHPDoc#Tags)