Pojmenování proměnné

There are only two hard things in Computer Science: cache invalidation and naming things.

AndreaAndrea

Zajímá vás, zda můžete použít daný řetězec jako název proměnné? Napište do políčka název a dozvíte se více

Toto je platný identifikátor podle ECMAScript ES2015 / Unicode 8.0.0. Tato verze sebou přinesla aktualizaci gramatiky identifikátorů.

Co je identifikátor?

Každá proměnná má jednoznačný název, který se nazývá identifikátor.

let name;
let _soukromí;
let $dollar;

Funkce jsou často definovány jako pojmenovaný blok kódu, kde ono pojmenování je také identifikátor. Dokonce i argumenty, které jsou předávány funkcím jsou identifikátory.

function jmenofunkce(pocet) {
	return 1 + pocet;
}

A názvy objektů a jejich vlastností jsou také identifikátory.

let pes = {
	jméno: 'Angie',
	narozena: 2007
};

Pravidla pojmenování

Při volbě tvorbě identifikátorů v JS je důležité myslet na několik věcí:

  • název může být tvoře buď písmenem, podtržítkem _ nebo $.
  • po prvním znaku mohou být číslice, znak _ nebo $.
  • nesmí obsahovat mezery nebo jiné speciální znaky, kromě výše uvedených. Identifikátory jsou také case-sensitive, tzn. rozlišují malé a velké písmena.

Klíčové slova

Identifikátor nesmí kolidovat s jinými klíčovými slovy v kódu. Také nesmí být rezervované slovo a ani null a true, false.

Konflikty s používanými knihovnami

Proměnná module se používá v NextJS. Nepojmenovávejte $ proměnné pokud používáte jQuery knihovnu.

Délka názvu

Délka názvu proměnné by měla korespondovat s rozsahem platnosti proměnné, pokud pojmenováváme:

  • blokovou proměnnou, která se například objevuje pouze v cyklech stačí pojmenovat jedním znakem i, j, k, l, …

  • lokální proměnnou, je přípustné kratší jméno cca o 5-20 znacích,

  • globální proměnnou bychom měli pojmenovat víceslovným názvem charakterizujícím použití.

Konvence

Způsob pojmenování prvků v kódu je velmi důležitý pro jeho čitelnost a srozumitelnost. Zkušení programátoři se snaží dbát na konzistentní a srozumitelné pojmenovávání, aby jejich kód byl přehledný a snadno se četl.

  • Je vhodné volit identifikátory z anglického jazyka (spolupráce s dalšími programátory, dokumentace).
  • Identifikátory by měly být v daném jmenném prostoru jednoznačné.
  • Název by měl být srozumitelný a vystihovat účel např. název lokální proměnné "productAverageCount" by byl lepší volbou než "x". Pro čtení a porozumění je vhodné, aby se identifikátory lišily již v několika málo prvních znacích. Není vhodné používat identifikátory příliš krátké nebo kryptické (např. akdr7345).
  • V některých fontech je vzhled číslice 1 a písmene l velmi podobný, další podobné znaky jsou číslice 0 a písmeno O.