Introduktion

  • 3 minuter

Koden som du skriver ska förmedla din avsikt till både kompilatorn och andra utvecklare som kan behöva läsa koden. Och eftersom du är den utvecklare som kommer att läsa din kod oftast, ibland månader efter att du ursprungligen skrev den, är det i ditt bästa intresse att skriva kod som är tydlig och lätt att förstå. Kom ihåg att du kan skriva kod en gång, men du måste läsa den många gånger.

Anta att du har blivit ombedd att skriva kod för en annan grupp utvecklare. Du träffar dem för att diskutera specifikationen och tilldelningen är tydlig. Efter mötet berättar de att du kommer att arbeta oberoende under utvecklingen. När du är klar lämnar du över koden till den andra gruppen. Kodningsuppgiften ligger inte utanför din kompetensnivå, men du har aldrig behövt skriva kod som någon annan kommer att underhålla. Teamet berättade för dig att så länge du följer standardkodningskonventionerna för C#, bör det inte finnas några problem. Du planerar att granska C#-kodningskonventionerna som är relaterade till den kod som du ska arbeta med.

I den här modulen får du lära dig hur du väljer namn för dina variabler som beskriver deras syfte och avsikt. Du får lära dig hur du lägger till kodkommentarer som dokumenterar kraven på högre nivå och din metod i kod, samt att tillfälligt instruera kompilatorn att ignorera kodrader. Slutligen lär du dig att använda tomt utrymme för att förmedla relationen mellan enskilda kodrader.

I slutet av den här modulen skriver du kod mer noggrant med fokus på läsbarhet och kvalitet som tydligt förmedlar information till både kompilatorn och andra utvecklare.

Viktigt!

Den här modulen innehåller kodningsaktiviteter som kräver Visual Studio Code. Du behöver åtkomst till en utvecklingsmiljö som har Visual Studio Code installerat och konfigurerat för C#-programutveckling.

Utbildningsmål

I den här modulen kommer du att:

  • Välja ett beskrivande namn för variabler som beskriver deras syfte och avsikt.
  • Använda kodkommentarer för att tillfälligt instruera kompilatorn att ignorera kodrader.
  • Använda kodkommentarer för att beskriva krav eller syften på högre nivå för ett kodavsnitt.
  • Skriva kod som på ett effektivt sätt använder tomt utrymme till att förmedla relationen mellan kodrader.

Förutsättningar

  • Erfarenhet av att använda Visual Studio Code för att skapa och köra C#-konsolprogram.
  • Du kan skriva ut meddelanden till konsolen med hjälp av Console.WriteLine().
  • Erfarenhet av att använda if- och else if-instruktioner för att skapa kodgrenar.