Optimální využití konvencí názvů, kódu a rozložení v C#

Programování není jen otázka logiky a syntaxi, ale také jasnosti a čitelnosti. Dobře strukturovaná aplikace nejen zlepšuje vaše vlastní porozumění kódu, ale také usnadňuje spolupráci v týmu. V této příručce se dozvíte, jak efektivně pracovat v C# dodržováním názvových, kódových a layoutových konvencí.

Nejdůležitější poznatky

Nejdůležitější body, které byste si z této příručky měli odnést, jsou:

• Názvy tříd vždy začínají velkým písmenem a používají Camel Case.
• Metody následují stejné konvence jako názvy tříd.
• Proměnné by měly začínat malým písmenem a také psát svá slova v Camel Case.
• Jasná struktura a čitelnost prostřednictvím layoutových konvencí výrazně zvyšují kvalitu vašeho kódu.

Podrobný návod

1. Názvy tříd

Začněme názvy tříd. Ty by měly vždy začínat velkým písmenem a nesmí obsahovat žádné mezery. To zabraňuje syntaktickým chybám. Pokud se název třídy skládá z více slov, používá se takzvaný způsob Camel Case. První slovo začíná velkým písmenem, následované dalšími slovy, která také začínají velkým písmenem. Například název třídy by mohl znít "Program".

2. Pojmenování metod

Pojmenování metod je v nejvyšší míře podobné jako u názvů tříd. Například metoda "KruhVypocitat" začíná první písmeno "Kruh" a "Vypocitat" velkým písmenem. Ani zde se používají žádné mezery, aby se udržela struktura metody.

3. Pojmenování argumentů metody

Při pojmenovávání argumentů metody je třeba dodržovat jiná pravidla. Ta by měla vždy začínat malým písmenem. Příklad: U metody by mohl být argument nazván "Arx", který následuje malým písmem.

4. Pojmenování proměnných

Teď se dostáváme k proměnným. Tyto názvy obvykle začínají malým písmenem, a pokud se skládají z více slov, další slova se opět píší v Camel Case. Příkladem je název proměnné „znakPocet“, kde „znak“ je malé a „Pocet“ velké, aby se zvýšila čitelnost.

5. Zkratky v názvech proměnných

Je dobré se vyhnout zkratkám v názvech proměnných. Ty mohou vést k nedorozuměním. Dalším důležitým aspektem je, že proměnné by nikdy neměly začínat číslicí. Příklad: Místo pojmenování proměnné "5Cislo" byste měli použít „cislo5“. To splňuje syntaktické požadavky Visual Studia.

6. Předpona pro proměnné

Užitečným trikem je přidání předpony k názvům proměnných, která určuje typ dat. Například u celé proměnné "i" předchází, což označuje 32bitové celé číslo. Celý název by mohl být „iCislo5“.

7. Dodržování layoutových konvencí

Na závěr záleží na tom, jak je kód uspořádán, aby se zlepšila čitelnost. Dbejte na to, aby v každém řádku byla pouze jedna instrukce a každá deklarace měla přidělen svůj vlastní řádek. Dalším bodem je správné použití tabulátorů nebo čtyř mezer pro odsazení.

8. Další informace a odkazy

Pokud chcete téma dále prohloubit, doporučuji vám oficiální webové stránky Microsoftu. Najdete tam podrobné informace o názvových konvencích, layoutových směrnicích a komentářích. Tyto informace jsou velmi užitečné pro čitelnost vašeho zdrojového kódu.

Shrnutí – porozumění názvovým, kódovým a layoutovým konvencím v C#

V této příručce jste získali komplexní přehled o různých názvových, kódových a layoutových konvencích v C#. Nyní víte, jak správně pojmenovat názvy tříd, metod a proměnných a jak důležité je mít jednotnou strukturu pro vaši programovací práci.