Elnevezési szabályok

Jó elnevezések, rövidítések kerülése, boolean nevek és félrevezető elnevezések.

Elnevezési szabályok (Naming)

Az elnevezés talán a legtöbbet ér az egész clean code eszköztárból. Egy jó név önmagában dokumentációt helyettesít.

Legyen a név kifejező

A változó, függvény vagy osztály neve legyen olyan, hogy az olvasónak ne kelljen kitalálnia, mit jelent.

// ❌ Rossz – mit jelent d, l, r?
const d = new Date();
const l = getList();
const r = compute(l, d);

// ✅ Javított – azonnal érthető kontextus
const currentDate = new Date();
const activeUserList = getActiveUsers();
const reportData = generateMonthlyReport(activeUserList, currentDate);

Kerüld a rövidítéseket

Az usr, btn, cfg típusú rövidítések ma már nem menthetők a „billentyűzet kímélés" érvével – az IDE-k automatikusan kiegészítenek.

// ❌ Rossz – rejtélyes rövidítések
const usrMgr = new UsrMgr();
const cfg = loadCfg();

// ✅ Javított – teljes, értelmes nevek
const userManager = new UserManager();
const appConfiguration = loadConfiguration();

Függvényneveknél ige + főnév

A függvények cselekvések, ezért nevükben igének kell szerepelnie.

// ❌ Rossz – nem ige, nem derül ki mi történik
function userData() { ... }
function report() { ... }

// ✅ Javított – ige + főnév pattern
function fetchUserData() { ... }
function generateMonthlyReport() { ... }

Boolean változók neve legyen állítás

// ❌ Rossz
const flag = checkUser();
if (flag) { ... }

// ✅ Javított
const isUserAuthenticated = checkUserAuthentication();
if (isUserAuthenticated) { ... }

Kerüld a félrevezető neveket

// ❌ Rossz – accountList nem lista, hanem Map
const accountList = new Map();

// ✅ Javított – a típus is tükröződik a névben
const accountMap = new Map();

Rövid összefoglaló

Adj olyan nevet, amelyből azonnal kiderül a szándék – ne kelljen komment hozzá.
Kerüld a rövidítéseket és a félrevezető elnevezéseket.
Függvényeknél ige + főnév, boolean változóknál is/has/can prefix ajánlott.

Elnevezési szabályok