The purpose of this PSR is to document (in a catalog style) the de facto list of tags historically in use in the PHP community.
We wish to properly standardize the de facto usage of tags as code documentation.
- Provide a complete technical definition, or schema, of the common tags in PHPDoc notation.
- Introduce new concepts matching best practices or design patterns in use today.
- This PSR does not provide a recommendation on how and when to use the concepts described in this document, so it is not a coding standard.
We have decided to formalize the existing practices, observe non-documented usages (such as Doctrine-style annotations), and observe feature requests with Documentation generators (such as phpDocumentor).
The combination of these should be described in sufficient detail as to reduce the amount of possible interpretation.
In addition to the above, the authors have taken care to provide for future expansions and tag additions that do not affect the Syntax of PHPDoc itself.
Pros:
- Delivers a machine-parsable and verifiable specification.
- Well-rounded proposal due to the number of factors considered.
Cons:
- Technical and verbose.
- Can only be extended when the syntax is not affected.
- Chuck Burgess - PEAR
- Ken Guest
- Jaap van Otterdijk - phpDocumentor
- Alexander Makarov - Yii
- Entrance Vote
- Acceptance Vote: TBD
Most of the relevant links are mentioned in the PSR itself as support for individual chapters.
Note: Order descending chronologically.