Style

Document Style

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.

Punctuation

• Method and class descriptions should be punctuated
• Property and parameter description should not be punctuated

Classes

Each class should have the following documentation block.

/**
 * [Class Description]
 *
 * @author John Doe <john.doe@litus.cc>
 */

Coding Style

Our coding style is described here.