C# Coding Conventions

Overview

This project follows the standard C# language code conventions from Microsoft. This page provides a comprehensive summary of the conventions used throughout the codebase.

Naming Conventions

Code Element	Convention	Example
Classes	TitleCase	`class Player`
`public` Fields	TitleCase	`public float Speed;`
`private` Fields	lowerCase	`private float targetFrameTime;`
Methods	TitleCase	`public Update()`, `private GetMaxHeight()`
Method parameters	lowerCase	`width`, `height`
Constants	lowerCase	`const int maxValue = 8;`
Enum	TitleCase	`enum GameScreen`
Enum members	TitleCase	`ScreenTitle`
Struct	TitleCase	`struct Material`

Code Formatting

Operators

Always include spaces around operators:

Operator	Convention	Example
Multiplication	value1 * value2	`int product = value * 6;`
Division	value1 / value2	`float division = value / 4.0f;`
Addition	value1 + value2	`int sum = value + 10;`
Subtraction	value1 - value2	`int res = value - 5;`
Ternary	(condition)? result1 : result2	`printf("Value is 0: %s", (value == 0)? "yes" : "no");`

Float Values

Always use the f suffix with float literals:

float gravity = 10.0f;
float speed = 5.5f;

Indentation and Spacing

Four spaces are used, instead of TABS
Trailing spaces are always avoided
All defined Fields SHOULD BE ALWAYS initialized

Control Flow Statements

Control flow statements are followed by a space:

If Statements

if (condition) value = 0;

if ((value > 1) && (value < 50) && valueActive)
{
    // Code here
}

All conditions are always between parenthesis, but not boolean values.

While Loops

while (!WindowShouldClose())
{
    // Game loop
}

For Loops

for (int i = 0; i < NUM_VALUES; i++) printf("%i", i);

Switch Statements

switch (value)
{
    case 0:
    {
        // Code here
    } break;
    case 2: break;
    default: break;
}

Braces and Brackets

Braces and curly brackets always open-close in aligned mode:

void SomeFunction()
{
    // TODO: Do something here!
}

The opening brace is on a new line, aligned with the function declaration or control flow statement.

Best Practices

Field Initialization

All defined fields should always be initialized when declared:

private float speed = 5.0f;
private int health = 100;
private bool isActive = false;

Condition Formatting

All conditions are always between parenthesis, but not boolean values:

if ((value > 1) && (value < 50) && valueActive)
{
    // valueActive is a boolean, so no parenthesis
}

Operator Spacing

Always include spaces around operators for readability:

// Good
int result = value1 + value2 * 3;

// Bad
int result=value1+value2*3;

Getting Started

Game Systems

Architecture

Development

Overview

Naming Conventions

Code Formatting

Operators

Float Values

Indentation and Spacing

Control Flow Statements

If Statements

While Loops

For Loops

Switch Statements

Braces and Brackets

Best Practices

Build docs developers (and LLMs) love

Getting Started

Game Systems

Architecture

Development

​Overview

​Naming Conventions

​Code Formatting

​Operators

​Float Values

​Indentation and Spacing

​Control Flow Statements

​If Statements

​While Loops

​For Loops

​Switch Statements

​Braces and Brackets

​Best Practices

Build docs developers (and LLMs) love

Overview

Naming Conventions

Code Formatting

Operators

Float Values

Indentation and Spacing

Control Flow Statements

If Statements

While Loops

For Loops

Switch Statements

Braces and Brackets

Best Practices