Topic: Coding Standards

I'm trying to work things out by looking at the source code, but to try to keep an internal consistency, I'll write down here so they can be corrected and seen by other potential contributors.

  • All code files should include the license at the top

  • Name of the original author of the file should be added before the license

  • All classes start with M (for Maratis I assume)

  • Function names are camelCase, starting with lower case

  • Member variables are prefixed by m_ and begin lower case

As far as I can tell, use of singletons is acceptable, but reserved for the engine and hardware devices.

That about right so far?

  • anael
  • Administrator
  • Offline

Re: Coding Standards

yes, perfect,
we can also mention the enums, all maj and starting with "M_" like :

enum M_MATRIX_MODES
{
        M_MATRIX_MODELVIEW = 0,
        M_MATRIX_PROJECTION,
        M_MATRIX_TEXTURE,
};