Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
We use the standard phpDoc tags (Cheat Sheet), using these small extra conventions.
FQDN (Fully Qualified Domain Name)
When a property holds an instance of a class, we use the FQDN of the class in the documentation.
- Method and class descriptions should be punctuated
- Property and parameter description should not be punctuated
Each class should have the following documentation block.
/** * [Class Description] * * @author John Doe <email@example.com> */
Our coding style is described here.