Coding Standards

Introduction

Some guidelines, such those about as comments and indentation, are based purely on convention, rather than on clear technical merit. However, conventions are important for readability, thus most conventions are musts.

A lot of our code was written before these guidelines existed. You should fix violations as you encounter them in the course of your normal coding. You must not fix violations en masse without warning other developers and coordinating with them, so as not to make the merging of branches more difficult than it already is.

We have added an editor.config file that will help enforce some of these standards. Changes should not be made to this file without discussion or agreement from team members.

Casing

Token	Casing Style	Example
Types	Pascal	public class SomeClass
Methods	Pascal	private int SomeFunction()
Local Variables	Camel	int myVariable

Work in progress