Namngivning

Språk och "bra namn"

Namnen i ett projekt bör alla vara på samma språk och följa samma mönster.

Ett bra namn är tydligt och beskriver informationen variabeln innehåller, eller den handling metoden gör. "hitPoints" är ett bättre namn än "x".

KategoriGrundtankeBra exempelnamn

Variabler Parametrar Properties

Den data som lagras

_hitPoints movementX hasBeenHit weaponDamage moneyOwed

Metoder

Den handling som utförs Ett verb

CheckCollision Draw Update LoadSavegame ApplyMovementVector

Klasser

Kategorinamn i singular

Enemy Level Powerup Button Book

PascalCase och camelCase

  • PascalCase: Inga mellanslag mellan orden, stor bokstav (versal) i början av varje ord.

  • camelCase: Inga mellanslag mellan orden, liten bokstav i början men i övrigt stor bokstav (versal) i början av varje ord.

Exempel

TypModellExempel

Projekt

PascalCase

SpaceShooter

PacMan

BreakoutClone

PascalCase

TakeDamage()

RestoreOriginalPosition()

Rest()

PascalCase

Enemy

ProjectileTarget

PowerupBox

PascalCase

HitPoints

Klassvariabler: public, protected

PascalCase

IsAlive

Klassvariabler: private

camelCase

_hitPoints

Lokala variabler ("vanliga variabler")

camelCase

hitPoints

mana

isFloating

Parametrar

camelCase

name

movementVector

Understreck

Understreck används i början av privata/protected variabler i klasser, och ingen annanstans.

public class Fighter
{
  private int _hp;
  protected int _mana;
  public int ShoeSize;
  public int Level { get; protected set; }
}

Last updated