Úvod

  • 3 min

Kód, který napíšete, by měl sdělit váš záměr jak kompilátoru, tak dalším vývojářům, kteří můžou potřebovat přečíst váš kód. A vzhledem k tomu, že jste vývojář, který bude kód číst nejčastěji, někdy měsíce poté, co jste ho původně napsali, je v nejlepším zájmu psát kód, který je jasný a snadno pochopitelný. Nezapomeňte, že kód můžete napsat jednou, ale budete ho muset přečíst mnohokrát.

Předpokládejme, že jste byli požádáni o napsání kódu pro jinou skupinu vývojářů. Setkáte se s nimi a proberete specifikaci a zadání je jasné. Po schůzce vám řeknou, že během vývoje budete pracovat nezávisle. Jakmile budete hotovi, předáte kód druhé skupině. Úkol kódování není nad rámec vaší úrovně dovedností, ale nikdy jste nemuseli psát kód, který bude někdo jiný udržovat. Tým vám řekl, že pokud dodržujete standardní konvence kódování pro jazyk C#, neměl by být žádný problém. Plánujete zkontrolovat konvence kódování jazyka C#, které se týkají kódu, na kterém budete pracovat.

V tomto modulu se dozvíte, jak zvolit názvy proměnných, které popisují jejich účel a záměr. Dozvíte se, jak přidat komentáře ke kódu, které dokumentují požadavky na vyšší úroveň a váš přístup v kódu, a také dočasně instruovat kompilátoru, aby ignoroval řádky kódu. Nakonec se dozvíte, jak lze k vyjádření vztahu jednotlivých řádků kódu využít prázdné znaky.

Na konci tohoto modulu budete psát kód smysluplněji, s ohledem na jeho čitelnost a kvalitu, což umožní předávat informace o vašem záměru jak kompilátoru, tak i dalším vývojářům.

Důležité

Tento modul zahrnuje aktivity kódování, které vyžadují Visual Studio Code. Budete potřebovat přístup k vývojovému prostředí, které má nainstalovaný a nakonfigurovaný Visual Studio Code pro vývoj aplikací v jazyce C#.

Cíle výuky

V tomto modulu:

  • Zvolíte popisné názvy proměnných, které popisují jejich účel a záměr.
  • Dáte kompilátoru pomocí komentářů ke kódu pokyn, aby určité řádky kódu dočasně ignoroval.
  • Pomocí komentářů ke kódu popíšete požadavky vyšší úrovně nebo účel úseku kódu.
  • Napíšete kód, který k vyjádření vztahu řádků kódu efektivně používá prázdné znaky.

Požadavky

  • Zkušenosti s vytvářením a spouštěním konzolových aplikací jazyka C# pomocí editoru Visual Studio Code
  • Zkušenosti s tiskem zpráv do konzoly pomocí Console.WriteLine().
  • Zkušenosti s používáním příkazů if a else if k vytváření větví kódu.