Style Guide

---

An overview of general guidelines to follow when writing our code to help figure out the underlying logical structure, improve consistency, readability, and maintainability of our source code

Note: Developers often have strong opinions on how code should be written. These guidelines are not meant to provoke a religious war on the correct way to format code. Merely to provide a consistent framework for development of our code over time by many different students. It's harder for new students to read and understand code that changes style frequently (depending on the original author).

---

• Layout Guide - Layout guidelines
• Naming Conventions - Guidelines on naming variables, functions, methods, classes, etc.
• Comments - Guidelines on using comments
• Special Cases^? - Various special cases that require a consistent style decision.

---

• Writing Self-Documenting Code - Brief overview of how to reduce the need for comments by increasing the readability of the code itself.

-- ShawnDB - 15 Jun 2008
to top