Naming conventions - všeobecné pravidlá pre názvy identifikátorov

V tomto príspevku je uvedených zopár všeobecných pravidiel pre tvorbu názvov identifikátorov. Uvedené pravidlá je možné aplikovať v ktoromkoľvek programovacom jazyku.

Anglické názvy

Pri tvorbe identifikátorov používajte anglické názvy. Vyhnete sa problémom, ktoré môže nastať, ak váš projekt bude rásť a prekročí hranice krajiny. Firma, ktorá si váš softvér kúpi, bude mať veľké problémy ho prispôsobiť, keďže názvom identifikátorov nebude rozumieť rovnako ako obsahu komentárov. Sám som toho svedkom, keď pracujem na zahraničnom projekte a všetky identifikátory a komentáre sú v nemeckom jazyku navyše s vlastnou konvenciou a skratkami pre špeciálne znaky (napr. ä, ö, ü, ß), nehovoriac o použitých skratkách pre slová a slovné výrazy.

Slang

Nepoužívajte slang v názvoch identifikátorov. Programátori iných národností často majú problém s angličtinou a ak sú navyše použité slangy, sťažuje to prácu ešte viac.

Vtipné slovné spojenia

Nepoužívajte vtipné slovné spojenia. V súčasnosti môžu byť aktuálne a jasné, ale zmenou situácie a s príchodom nových programátorov nebudú už dávať zmysel.

Vyberte si jedno slovo

Vyberte si jedno slovo pre daný typ funkcie alebo metódy a buďte konzistentný. Nepoužívajte pre rovnaký typ funkcie v rôznych triedach rôzne slovné názvy (napr. fetch, retrieve, get), ale len jeden, napríklad get.

Držte sa názvoslovia a účelu

Snažte sa vyhnúť stavu, kedy bude určitý názov zastupovať rôzne funkcie. Napríklad ak definujem metódy typu add, budem očakávať pridávanie a nie sčítavanie. Inak povedané, aby v jednej triede metóda s názvom add() nerobila pridávanie a v inej zase sčítavanie. Pre zamedzenie tohto javu definujte názvy metód a ich očakávané správanie (napr. add, insert, append) alebo vytvorte zmysluplný názov (napr. addNewItem()).

Záver

Týmto článkom bol začatý seriál zameraný na názvoslovia pri tvorbe programového kódu. V prípade, že máte ďalšie všeobecné tipy pre tvorbu názvov identifikátorov, podeľte sa o ne prostredníctvom komentára. V ďalších článkoch zameraných na názvoslovia sa budem venovať aj názvosloviam pre konkrétne typy identifikátorov.