CodeStyle.wiki

Basic Rules

We strictly use 2 spaces instead of tabs.

Guidelines

Because SimulationCraft is a open-source project mainly developed by hobby programers, we try to focus strongly on code readability. Always try to make your code as easy to read as possible and don't hold back on whitespace.

Try to put as much comments into the code as possible as it makes it much easier for other/new developers to understand the meaning of a code block and the intention of it.

Try to document Game mechanics, especially non-intuitive behaviour and bugs with information on who tested/implemented it and add a date to it.