Code and Comment Style Guidelines

Comments and Inline Documentation

Non-trivial methods should have a docblock formatted like the example below after the first line and opening bracket, and lines should wrap at 80 characters, like so:

<example to be posted>

Inline comments should be complete sentences, and should be brief, only added when they will add clarity to what's happening in the code. Inline comments should typically be one line, but if you need to wrap at 80 characters, continue using // to indicate new lines of the comment.

Class Formatting and Conventions

TODO