punkfuncgames/code-style

Code Style Reference

Naming Conventions

| Element | Convention | Example | |---------|-----------|---------| | Private fields | _camelCase | _playerHealth | | Properties/Methods | PascalCase | GetPlayerHealth() | | Constants | UPPER_SNAKE_CASE | MAX_HEALTH | | Visibility | Always explicit private | private int _count; |

Explicit Types Only

Never use var. Always declare the concrete type.

// Correct
Dictionary<string, int> scores = new Dictionary<string, int>();
CurrencyContainer gold = _wallet.GetContainer("Gold");

// Forbidden
var scores = new Dictionary<string, int>();
var gold = _wallet.GetContainer("Gold");

One Attribute Per Line

Never chain attributes on the same line. Each attribute gets its own line.

// Correct
[SerializeField]
[Range(0f, 1f)]
private float _alpha;

// Forbidden
[SerializeField, Range(0f, 1f)]
private float _alpha;

// Forbidden
[SerializeField][Range(0f, 1f)]
private float _alpha;

Unity Object Null Checks

Use implicit bool for any UnityEngine.Object subclass (MonoBehaviour, ScriptableObject, Component, GameObject). Unity overrides == for lifecycle tracking — using == null / != null bypasses this.

// Correct — handles Unity's fake-null
if (myTransform)
{
    myTransform.SetParent(parent);
}

if (!myGameObject)
{
    _logService.Error("Missing reference");
}

// Forbidden — bypasses Unity lifecycle checks
if (myTransform != null) { ... }
if (myGameObject == null) { ... }

Disambiguate Object

When both System.Object and UnityEngine.Object are in scope, always use fully qualified name or alias:

// At file top
using Object = UnityEngine.Object;

// Or inline
UnityEngine.Object.Destroy(go);

Field Grouping

Group fields by their full declaration signature (modifiers + type). Same-signature fields are contiguous (no blank lines between them). Different-signature groups are separated by a blank line.

private readonly IWalletService _walletService;
private readonly ISaveService _saveService;
private readonly ILogService _logService;

private readonly CompositeDisposable _disposables = new();

private bool _isInitialized;
private bool _isDirty;

private float _saveInterval;

Class Layout Order

1. Constants
2. Fields
3. Properties
4. Constructors
5. Lifecycle (Start/Awake)
6. Event subscriptions
7. Public methods
8. Private methods
9. Cleanup (Dispose/OnDestroy)
10. Nested types

Self-Documenting Code

• No comments, no XML docs (///)
• No debug logs or commented-out code in commits
• Code should be readable without explanation

Mandatory Braces

All blocks require braces, even single-line:

// Correct
if (condition)
{
    DoSomething();
}

// Forbidden
if (condition)
    DoSomething();

Injection Patterns

• Pure C# classes: Constructor injection
• MonoBehaviours: [Inject] method injection

Async Rules

• All async methods must accept CancellationToken
• Use UniTaskVoid + .Forget() for fire-and-forget
• MonoBehaviours: this.GetCancellationTokenOnDestroy()
• Never use async Task in production code (only in test methods for NUnit)

Reactive Rules

• ReactiveProperty<T> for mutable state
• ReadOnlyReactiveProperty<T> for exposure
• .AddTo(_disposables) for pure C# classes
• .AddTo(this) for MonoBehaviours
• Implement IDisposable and dispose CompositeDisposable

Input Rules

• Never use legacy UnityEngine.Input (Input.GetMouseButtonDown, Input.mousePosition, Input.GetKey, etc.)
• Always use IInputService from the input package (#if PUNKFUNC_INPUT)
• Subscribe to observables: OnPrimaryAction, OnSecondaryAction, OnInteract, OnPause
• Read continuous state: Movement.CurrentValue, MousePosition.CurrentValue, IsPrimaryHeld.CurrentValue
• Guard with #if PUNKFUNC_INPUT so the project compiles without the package

Events

• Define as readonly struct
• Register brokers: builder.RegisterMessageBroker<T>(options) in installers