Aktuálně: Postihly zákazy tvou profesi? Poptávka po ajťácích prudce roste, využij slevové akce 50% výuky zdarma!
Pouze tento týden sleva až 80 % na e-learning týkající se Javy
Discount week - May - 50

Lekce 5 - Nejčastější chyby C# začátečníků - Umíš pojmenovat proměnné? Nové

V minulé lekci C#.NET kurzu, Typový systém podruhé: Datové typy v C# .NET, jsme si podrobně probrali datové typy.

V dnešním C# .NET tutoriálu si ukážeme první tzv. dobré praktiky pro programování v C# .NET. Nejen nováčci je často porušují a zanáší tak do svých programů zbytečné chyby, možná je děláš také?

Slovo senior programátora

David Čápka

Gratuluji ke zdolání prvních lekcí Základních konstrukcí jazyka C# .NET!

Materiál pro dnešní lekci jsem sestavil na základě 20letých zkušeností s programováním. Jako šéfredaktorovi a lektorovi mi rukama prošly stovky, možná tisíce zdrojových kódů vytvořených komunitou. Nebylo těžké si všimnout, že většina z nich, ačkoli funguje, obsahuje zbytečné chyby, které se navíc stále dokola opakují. Chyby kupodivu často dělali jak nováčci, tak zkušenější programátoři a i já jsem je dělal, když jsem začínal.

Došel jsem k tomu, že základním a mylným předpokladem je:

✗ Program je správně, pokud funguje.

Programy a domy

Pokud stavíme dům, že se nám líbí a nefouká do něj neznamená, že je správně. Dům totiž musí mít promyšlenou architekturu a pokud nemá základy, za pár let se nám začne sesouvat.

Programování je často přirovnáváno ke stavebnictví právě z ohledu na architekturu, zde ovšem tu softwarovou. Vysvětleme si proč.

Lidský mozek dokáže najednou pracovat jen s určitým omezeným množstvím informací. Zjednodušeně můžeme říci, že pokud je program nepřehledně napsaný, od určité chvíle by musel programátor udržet v hlavě více věcí, než člověk vůbec dokáže. Přidávání dalších funkcí do takového programu pak vždy způsobí, že v aplikaci vznikne chyba. V praxi to dopadá tak, že hobby projekt autora "přestane bavit" nebo komerční projekt zkrachuje, protože je "už moc složitý".

Uveďme si ještě jiný příklad - Když bude naše domácnost uspořádaná tak, že bude kladivo v lékárničce, která bude umístěna ve sklepě, asi těžko v ní budeme schopní efektivně fungovat. Ačkoli tento příklad zní absurdně, jeho alternativy v podobě programů vznikají denně.

Kdy je program správně?

To je snadné. Program je správně, pokud:

  • funguje,
  • dodržuje dobré praktiky a
  • je otestovaný.

Všimněte si, že funkcionalita z pohledu uživatele programu představuje jen 1/3 kritérií kvality programu. Podobně, jako funkčnost domu z pohledu bydlícího představuje asi jen zlomek jeho reálné kvality z hlediska stavařiny.

Právě o porušování dobrých praktik a kvalitě kódu se dnes budeme bavit. Záleží nám na tom, abyste byli opravdu dobří, proto těchto lekcí naleznete napříč našimi kurzy ještě několik.

Jak správně pojmenovávat proměnné?

Tento výukový obsah pomáhají rozvíjet následující firmy, které dost možná hledají právě tebe!

Říká se, že 10% času něco programujeme a 90% času pro to vymýšlíme název ;-) Jedná se samozřejmě o nadsázku, nicméně vtip naráží na nutnost strávit určitý čas nad vymýšlením názvů proměnných. To aby každý včetně nás vracejících se po pár měsících k vlastnímu kódu, pochopil, k čemu ona proměnná slouží. Obecně se dá spolehnout na jednoduché pravidlo:

Proměnné vždy pojmenováváme podle toho, co obsahují, nikoli podle toho, k čemu v programu slouží.

Porovnejme následující 2 kódy:

✗ Špatně

string vypis, text2;
int[5] pole;
int foo, bar, x, vypocet;

✓ Správně

string nazev, jmeno;
int[5] odpovedi;
int i, j, bonus, celkovyBonus;

Oba kódy vytvářejí proměnné pro jednoduchý konzolový kvíz. U prvního příkladu není vůbec jasné, co některé proměnné obsahují, např. pojmenovat proměnnou pole má asi stejnou vypovídací hodnotu, jako bychom ji pojmenovali promenna.

Častá chyba je, že chceme např. uložit výsledek nějakého výpočtu a proměnnou pojmenujeme vypocet. Výpočet s proměnnou ovšem vůbec nesouvisí, to je nějaká akce (děj), proměnná obsahuje vždy hodnotu (výsledek děje). Tou je zde v případě kvízu celkovyBonus. Podobně je v prvním kódu pojmenovaná proměnná vypis, protože ji někde vypisujeme. Z druhého kódu ale reálně vidíme, že obsahuje název kvízu.

Ruku na srdce - kdo z vás by pochopil, že kód vlevo je program na kvízy?

Také nikdy nepojmenováváme proměnné pomocna nebo pom apod.

Pozor na "Czechglish" a diakritiku

Ve zdrojovém kódu je na naší úrovni začátečníků jedno, jakým jazykem budeme pojmenovávat proměnné (pokud tedy nepošleme Angličanovi kód v češtině).

Proměnné v jednom projektu pojmenováváme jedním jazykem a pokud česky, tak bez diakritiky!

Opět si ukažme příklady:

✗ Špatně

string zpráva = "Čau!";
int count;

✓ Správně

string zprava = "Čau!";
int pocet;

Nebo:

string message = "Čau!";
int count;

V identifikátorech (např. v názvech proměnných) nikdy nepoužíváme háčky a čárky. V hodnotách v nich uložených je to již samozřejmě v pořádku.

Přestože moderní jazyky podporují kódování UTF-8 i v identifikátorech, lze velmi snadno na háček nebo čárku zapomenout a používáme pak jinou proměnnou! Navíc soubor se zdrojovým kódem může zpracovávat aplikace, která jej nepodporuje, a typicky se to i časem stane (např. je občas problém zobrazit diakritiku v příloze mailovým klientem apod.).

Víceslovné proměnné

Dnešní aplikace jsou stále složitější. Často se stane, že by jedno slovo nestačilo k popisu toho, co je v proměnné uloženo. Pak je výhodné použít více slov. Krátké identifikátory z 80. let tak v současných business aplikacích střídají i poměrně dlouhé názvy jako userObjectOutputStreamFactory a podobně.

Takto dlouhý název má ovšem smysl jen ve složité aplikaci, kde je několik podobných proměnných a proto musíme přidat další slovo. Nebudeme tedy v Hello world aplikaci vytvářet proměnnou textSPozdravemHelloWorld, ale stačí nám tam jen pozdrav, pokud tam jiný není :)

Oddělení slov

Kvůli čitelnosti slova v takovém názvu proměnné musíme nějak oddělit:

  • Více slov oddělujeme podle konvence daného programovacího jazyka, ta je v C# tzv. camelCase (česky velbloudí notace, kdy každé další slovo má velké písmeno a název pak vypadá jako hrby). V jiných jazycích se může používat např. podtržítko jako snake_case a další notace.
  • Vyhneme se pokud možno číslování proměnných a už vůbec nepíšeme čísla slovy, ne pozdrav2 ani pozdravDve. "Dvě" totiž nic neříká o tom, co pozdrav obsahuje.
camelCase snake_case

Ukažme si to na příkladech:

✗ Špatně

string zprava1;
string zpravaDve;

Zde není jasné co je uloženo:

string prijato; // text, bajty, zprava, objednavka, ...?
string odeslano;

A zde je název nečitelný:

string prijatazprava;
string odeslanazprava;

✓ Správně

string prijataZprava;
string odeslanaZprava;

Nepoužíváme zkratky

Tuto podkapitolu započněme citací:

Všichni si lámali hlavu, k čemu je ten sloupec DATNAR. Až se jednou zjistilo, že je to prej datum narození.

Tato špatná praktika je vlastně opakem víceslovných názvů proměnných. Nevymýšlíme nesmyslné zkratky, například z názvu pz nikdo nepozná, že myslíme prijataZprava. Pomůcka může být:

Pokud se na kód podívá někdo jiný než my, měl by přesně vědět, co v které proměnné je.

✗ Špatně

string zp;
int pz;

✓ Správně

string zprava;
int pocetZprav;

Jak jsme slibovali, k tématu dobrých praktik se ještě několikrát vrátíme v podobných, spíše odpočinkových lekcích :)

V následujícím cvičení, Řešené úlohy k 4.-5. lekci C# .NET, si procvičíme nabyté zkušenosti z předchozích lekcí.


 

Předchozí článek
Typový systém podruhé: Datové typy v C# .NET
Všechny články v sekci
Základní konstrukce jazyka C# .NET
Článek pro vás napsal David Čápka
Avatar
Jak se ti líbí článek?
6 hlasů
David je zakladatelem ITnetwork a programování se profesionálně věnuje 13 let. Má rád Nirvanu, sushi a svobodu podnikání.
Unicorn university David se informační technologie naučil na Unicorn University - prestižní soukromé vysoké škole IT a ekonomie.
Aktivity (9)

 

 

Komentáře

Avatar
Tibor Galloš:25. února 13:13

Výborný článok. Ďakujem.

Editováno 25. února 13:14
Odpovědět
25. února 13:13
Všetko je možné.
Avatar
David Čápka
Tým ITnetwork
Avatar
Odpovídá na Tibor Galloš
David Čápka:25. února 13:22

Díky, zrovna přidávám do základů ještě jeden takový :)

Odpovědět
25. února 13:22
Jsem moc rád, že jsi na síti, a přeji ti top IT kariéru, ať jako zaměstnanec nebo podnikatel. Máš na to! :)
Avatar
Luboš Běhounek Satik
Autoredaktor
Avatar
Luboš Běhounek Satik:26. února 11:15

Ještě mám jednu připomínku k těm názvům indexových proměnných.

Používat jako název indexovací proměnné v cyklu jen třeba i považuju za ok, pokud je to třeba jednořádkový kód, ale u čehokoliv složitějšího nebo pokud jsou tam indexovací proměnné dvě nebo dokonce víc (typicky vnořené cykly), tak doporučuju spíš pojmenovávat i ty indexovací proměnné nějak smysluplněji, aby dál v kódu bylo hned jasné, čeho index to je.

Pro srovnání, místo:

for (int i=0; i<meshes.Count(); i++)
  for (int j=0; j<meshes[i].Count(); j++)
  {
    var face = meshes[i][j];
    ...
  }

bych raději použil:

for (int iMesh=0; iMesh<meshes.Count(); iMesh++)
  for (int iFace=0; iFace<meshes[iMesh].Count(); iFace++)
  {
    var face = meshes[iMesh][iFace];
    ...
  }

Obzvlášť pokud by se s těmi indexovými proměnnými pracovalo nějak víc i dál uvnitř těch cyklů (než jen třeba vytáhnout něco do lokální proměnné).

Odpovědět
26. února 11:15
https://www.facebook.com/peasantsandcastles/
Avatar
Virtual
Super redaktor
Avatar
Virtual:28. února 16:29

Užitečná rekapitulace - díky!

Odpovědět
28. února 16:29
Rozdíl mezi tím, kým jsme a tím, kým chceme být, je jen v tom, co děláme.
Tento výukový obsah pomáhají rozvíjet následující firmy, které dost možná hledají právě tebe!
Avatar
Soňa Malířová:15. března 22:18

Líbí se mi ty obrázkové pomůcky (velbloud, had), pomáhá to zapamatování. Děkuju.

Editováno 15. března 22:18
 
Odpovědět
15. března 22:18
Avatar
Rostislav Pavelka:3. dubna 11:06

Programování je ryze subjektivní a nikoliv objektivní. Stejně jako malování či fotografie.
Programátoři jsou velmi svobodomyslná skupina a definovat takhle z patra nějaká pravidla je nedobré - to si musí vytvořit daná firma jako vnitrofiremní procesy. A vždy to musí sloužit k účelu, jaký má daná firma. A to se jaksi velmi liší firma od firmy.

Odpovědět
3. dubna 11:06
Svět je krásné místo k žití - hlavně se z něj ale neposrat :D
Avatar
Luboš Běhounek Satik
Autoredaktor
Avatar
Odpovídá na Rostislav Pavelka
Luboš Běhounek Satik:5. dubna 22:28

Víceméně ano, ale pořád to chce dodržovat aspoň takovéhle základy, aby když do projektu přijde nový člověk měl tu orientaci v kódu co nejjednodušší.

Odpovědět
5. dubna 22:28
https://www.facebook.com/peasantsandcastles/
Avatar
David Čápka
Tým ITnetwork
Avatar
Odpovídá na Rostislav Pavelka
David Čápka:6. dubna 9:56

Předpokládám, že jsi sám tato pravidla neznal, což bude možná důvod, proč jsi je odsoudil? Čekal jsem, že sem někdo dříve či později něco takového napíše, je přirozené se bránit, když se zjistí, že jsi chyboval/chybuješ. Ale je to jako bys říkal, že je řízení automobilu je subjektivní a každý si má udělat svoje pravidla na silnici. Ať chceš nebo ne, jakmile svým jednáním ovlivňuješ další lidi, musíš již jen z principu dodržovat nějaká pravidla, ať jde o cokoli. A pravidla nestačí v žádném případě definovat jen v rámci organizace, protože ta používá ve svých projektech knihovny vyvinuté dalšími organizacemi. V dnešní době je software tak komplexní a pracuješ s prací tolika různých týmů, že tvůj přístup by v praxi způsobil velké zmatky a s tím spojenou finanční ztrátu, proto se to tak nedělá.

Odpovědět
6. dubna 9:56
Jsem moc rád, že jsi na síti, a přeji ti top IT kariéru, ať jako zaměstnanec nebo podnikatel. Máš na to! :)
Děláme co je v našich silách, aby byly zdejší diskuze co nejkvalitnější. Proto do nich také mohou přispívat pouze registrovaní členové. Pro zapojení do diskuze se přihlas. Pokud ještě nemáš účet, zaregistruj se, je to zdarma.

Zobrazeno 8 zpráv z 8.