Code Style

[simonbw]

We need to go through the code and make the style consistent. This means a few things.

• Naming Conventions: We need to have consistent naming schemes for classes, methods, local variables, files, etc.
• Pointers vs references: We should decide to favor either pointers or references. So far most of the code uses pointers, but I suggest we use references since it is a feature of C++ that is quite nice.
• Comments: We need to make sure every class, method, field and constant is properly documented in the right place (.h vs .cpp)
• Folder Structure: We should have an agreed upon scheme for putting files in folders
• Namespaces: We should agree on namespace conventions (possibly related to folder structure)
• C++ Features: There are many different ways to do things in C++. Often there is a C way, a C++ way, and a C++11 way. Some specific examples include casting, smart pointers, defines vs constants, templates, strings, etc.

[simonbw]

I think we should create a Code Style wiki page to reference.