Zrozumienie komentarzy i czytelności kodu

Witamy w kolejnej lekcji! W tej lekcji dowiedzą się Państwo, jak używać komentarzy do dokumentowania kodu i poprawiania jego czytelności. Zaczynajmy!

Czym są komentarze?

Komentarze to wiersze kodu ignorowane przez kompilator. Służą do wyjaśniania działania kodu lub zostawiania notatek dla siebie i innych.

Najważniejsze: Komentarze ułatwiają zrozumienie kodu i jego utrzymanie.

Rodzaje komentarzy w C#

C# obsługuje trzy rodzaje komentarzy:

• Komentarze jednowierszowe: Zaczynają się od //.
• Komentarze wielowierszowe: Są umieszczane między /* a */.
• Komentarze dokumentacji XML: Zaczynają się od /// i służą do celów dokumentacyjnych.

Wskazówka: Należy używać odpowiedniego rodzaju komentarza w zależności od potrzeb.

Komentarze jednowierszowe

Komentarze jednowierszowe służą do wyjaśniania konkretnego wiersza kodu. Przykład:

Wskazówka: Komentarzy jednowierszowych należy używać do krótkich wyjaśnień.

using System;

class Program {
    static void Main() {
        // This is a single-line comment
        Console.WriteLine("Hello, World!"); 
// Outputs "Hello, World!"
    }
}

Komentarze wielowierszowe

Komentarze wielowierszowe służą do zamieszczania dłuższych wyjaśnień lub tymczasowego wyłączania bloków kodu. Przykład:

Najważniejsze: Komentarzy wielowierszowych należy używać do opisywania złożonej logiki lub fragmentów kodu.

using System;

class Program {
    static void Main() {
        /*
        This is a multi-line comment.
        It can span multiple lines.
        */
        Console.WriteLine("Hello, World!");
    }
}

Komentarze dokumentacji XML

Komentarze dokumentacji XML służą do generowania dokumentacji metod, klas i innych elementów kodu. Przykład:

Wskazówka: Komentarzy XML należy używać do tworzenia szczegółowej dokumentacji kodu.

/// <summary>
/// This method prints a greeting to the console.
/// </summary>
static void Greet() {
    Console.WriteLine("Hello!");
}

Poprawa czytelności kodu

Czytelny kod łatwiej zrozumieć i utrzymać. Aby poprawić jego czytelność, należy przestrzegać następujących wskazówek:

• Należy używać znaczących nazw zmiennych i metod.
• Należy konsekwentnie stosować wcięcia w kodzie.
• Należy grupować powiązane wiersze kodu.
• Należy pisać komentarze tylko wtedy, gdy są potrzebne, aby uniknąć niepotrzebnego bałaganu.

Wskazówka: Dobrze uporządkowany i skomentowany kod oszczędza czas podczas debugowania i współpracy.

Zadanie praktyczne

Proszę napisać program zawierający komentarze jednowierszowe, wielowierszowe i komentarze XML. Przykład:

Wyzwanie: Proszę dodać znaczące komentarze do wcześniej napisanego programu.

using System;

class Program {
    /// <summary>
    /// Main method: the entry point of the program.
    /// </summary>
    static void Main() {
        // Print a welcome message
        Console.WriteLine("Welcome to C# programming!");

        /*
        Below is an example
        of multi-line comments.
        */
        Console.WriteLine("Comments help explain code.");
    }
}

Świetna robota!

Gratulacje! Poznali Państwo sposób używania komentarzy do wyjaśniania i dokumentowania kodu oraz poprawiania jego czytelności. W następnej lekcji przejdziemy do sterowania przepływem i nauczymy się podejmować decyzje w programach za pomocą instrukcji if-else. Kontynuujmy kodowanie!