Optimálne využitie konvencií názvov, kódu a rozloženia v C#

Programovanie nie je len otázkou logiky a syntaxy, ale aj jasnosti a čitateľnosti. Dobre štruktúrovaná aplikácia nielenže zlepšuje tvoje vlastné pochopenie kódu, ale aj uľahčuje spoluprácu v tíme. V tejto príručke sa dozvieš, ako môžeš efektívne pracovať dodržiavaním menovacích-, kódových a rozloženiových konvencií v C#.

Najdôležitejšie zistenia

Medzi najdôležitejšie body, ktoré by si si mal z tejto príručky odniesť, patrí:

• Názvy tried začínajú vždy veľkým písmenom a používajú Camel Case.
• Metódy dodržiavajú rovnaké konvencie ako názvy tried.
• Premenné by mali začínať malým písmenom a ich slová by mali byť taktiež písané v Camel Case.
• Jasná štruktúra a čitateľnosť prostredníctvom rozloženových konvencií značne zvyšujú kvalitu tvojho kódu.

Krok za krokom návod

1. Názvy tried

Začneme názvami tried. Tieto by mali vždy začínať veľkým písmenom a nesmú obsahovať medzery. To zabraňuje syntaktickým chybám. Ak sa názov triedy skladá z viacerých slov, používa sa takzvaný zápis Camel Case. Prvé slovo začína veľkým písmenom, za ktorým nasledujú ďalšie slová, taktiež s veľkým začiatočným písmenom. Napríklad by názov triedy mohol znieť "Program".

2. Pomenovanie metód

Pomenovanie metód prebieha do veľkej miery podobne ako pri názvoch tried. Zoberme si napríklad metódu „KruhVypočítať“. Tu prvé písmeno „Kruh“ a „Vypočítať“ začína veľkým písmenom. Ani tu sa nepoužívajú medzery, aby sa zachovala metodická štruktúra.

3. Pomenovanie argumentov metódy

Pri pomenovaní argumentov metódy je potrebné dbať na iné pravidlá. Tieto by mali vždy začínať malým písmenom. Príklad: Pri metóde by sa argument „Arx“ mohol pomenovať, čo nasleduje po malom písmene.

4. Pomenovanie premenných

Teraz prejdeme k premenným. Tieto názvy obvykle začínajú malým písmenom a ak sa skladajú z viacerých slov, ďalšie slová prichádzajú opäť v Camel Case. Príkladom je názov premennej „znakPočet“, pričom „znak“ je malé písmeno a „Počet“ je napísané veľkým písmenom, aby sa zvýšila čitateľnosť.

5. Skratky v názvoch premenných

Je rozumné sa vyhnúť skratkám v názvoch premenných. Tieto môžu viesť k nedorozumeniam. Dôležitým aspektom je tiež to, že premenné by nikdy nemali začínať číslom. Príklad: Namiesto pomenovania premennej "5Číslo" by si mal použiť „číslo5“. Týmto sa spĺňajú syntaktické požiadavky Visual Studia.

6. Predpona pre premenné

Užitočným trik je pridať predponu k názvom premenných, ktorá uvádza typ údajov. Napríklad pri celej premene „i“ je predponou, čo znamená 32-bitové celé číslo. Celkový názov by mohol byť „iČíslo5“.

7. Dodržiavanie rozloženiových konvencií

Na záver je dôležité rozloženie kódu na zlepšenie čitateľnosti. Dbaj na to, aby v každom riadku bola len jedna inštrukcia a aby každá deklarácia bola priradená svojmu vlastnému riadku. Ďalší bod je správne používanie tabulátorov alebo štyroch medzier pre odsadenia.

8. Hĺbkové informácie a odkazy na ďalšie zdroje

Ako chceš hlbšie preskúmať tému, odporúčam ti oficiálnu webovú stránku Microsoftu. Tam nájdeš podrobné informácie o menovacích konvenciách, rozloženových smerniciach a komentároch. Tieto informácie sú veľmi užitočné pre čitateľnosť tvojho zdrojového kódu.

Zhrnutie – Pochopenie menovacích, kódových a rozloženových konvencií C#

V tejto príručke si získal komplexný prehľad o rôznych menovacích, kódových a rozloženových konvenciách v C#. Teraz vieš, ako správne pomenovať názvy tried, metódy a premenné a aké dôležité je mať jednotnú štruktúru pre tvoju programátorskú prax.