Skip to content

Code Style Document

Valk edited this page Sep 25, 2024 · 33 revisions

C# Coding Guidelines

Principles

Please familiarize yourself with these principles.

General Guidelines

  • Create Context classes for methods with more than 2 parameters
  • Favor Composition Over Inheritance
  • Hide what others should not see with Encapsulation

Formatting

  • Indentation: 4 spaces.
  • Curly Braces: Always expand.
  • Using Directives: Above namespace.

Naming

  • PascalCase: Types, methods, properties, constants, events.
  • camelCase: Private fields, local variables, method args.
  • Prefixes: On for events, Set for set methods, Get for get methods

Language Features

  • Static Functions: Use when possible.
  • CallDeferred(): Avoid if alternatives exist.
  • var Keyword: Never use.
  • C# Delegate Events: Always use over Godot signals.
  • Explicit Private Modifiers: Always specify private.
Clone this wiki locally