a simple rule book so I remember how I should name functions, variables and etc.
- Namespaces, classes and functions must start with capital letter
- namespaces (if it will help), classes, functions and variables must need comments or summaries to help understand what they do
- Summaries require "- " at the start of every <Param> Section
- If function has default. then include (default = {DefaultValue}) before the "- "
- Function Parameters must start with lowercase letter
- Do not use #param region inside functions as it lowers readablity
- Class and Enum Members/attributes must start with capital letter
- Experimental features must be in the header file to which they relate
- Try to make functions as widely usable as possible (instead of making a function for each string type to center it, make a templated function that can take in any char type)
- Adding
TODO: {comment describing what needs to be done}andWARNING: {comment describing why this might becoming a problem}in comments to either tag a line of code or an area of code for either something to be done or for something that might become a problem - Try to solve problems with the most simple solution to not create confusing code, products or a buggy mess