Wprowadzenie

  • {liczbaMinut} minut

Kod, który piszesz, powinien komunikować się zarówno z kompilatorem, jak i innymi deweloperami, którzy mogą wymagać odczytania kodu. A ponieważ jesteś deweloperem, który będzie czytać kod najczęściej, czasami kilka miesięcy po jego napisaniu, najlepiej jest napisać kod, który jest jasny i łatwy do zrozumienia. Pamiętaj, że możesz napisać kod raz, ale trzeba będzie go odczytać wiele razy.

Załóżmy, że poproszono Cię o napisanie kodu dla innej grupy deweloperów. Spotkasz się z nimi, aby omówić specyfikację, a przypisanie jest jasne. Po spotkaniu poinformują Cię, że będziesz pracować niezależnie podczas opracowywania. Gdy wszystko będzie gotowe, przekażesz kod do drugiej grupy. Zadanie kodowania nie wykracza poza poziom umiejętności, ale nigdy nie trzeba było pisać kodu, który ktoś inny będzie utrzymywać. Zespół powiedział Ci, że o ile przestrzegasz standardowych konwencji kodowania dla języka C#, nie powinno być problemu. Planujesz przejrzeć konwencje kodowania języka C#, które odnoszą się do kodu, nad którym będziesz pracować.

W tym module dowiesz się, jak wybierać nazwy zmiennych, które opisują ich przeznaczenie i intencję. Dowiesz się, jak dodawać komentarze kodu dokumentujące wymagania wyższego poziomu i podejście w kodzie, a także tymczasowo poinstruować kompilatora, aby ignorował wiersze kodu. Ponadto dowiesz się, jak można używać białych znaków do przekazania wzajemnych relacji poszczególnych wierszy kodu.

Po ukończeniu tego modułu będziesz pisać kod bardziej celowo, skupiając się na czytelności i jakości kodu w celu zapewnienia komunikacji zarówno z kompilatorem, jak i z innymi deweloperami.

Ważne

Ten moduł zawiera działania programistyczne, które wymagają programu Visual Studio Code. Będziesz potrzebować dostępu do środowiska programistycznego z zainstalowanym i skonfigurowanym do tworzenia aplikacji w języku C#.

Cele szkolenia

Zawartość tego modułu:

  • Wybieranie dla zmiennych opisowych nazw, które oddają ich przeznaczenie i cel.
  • Używanie komentarzy kodu do tymczasowego nakazania kompilatorowi ignorowania wierszy kodu.
  • Używanie komentarzy kodu do opisania wysokopoziomowych wymagań dla fragmentu kodu lub jego przeznaczenia.
  • Pisanie kodu, który efektywnie używa białych znaków do przekazania relacji między wierszami kodu.

Wymagania wstępne

  • Doświadczenie w tworzeniu i uruchamianiu aplikacji konsolowych języka C#przy użyciu programu Visual Studio Code.
  • Doświadczenie w drukowaniu komunikatów w konsoli przy użyciu polecenia Console.WriteLine().
  • Doświadczenie w tworzeniu gałęzi kodu przy użyciu instrukcji if i else if .