Komentarze

Komentarze w języku Python pełnią kluczową rolę w tworzeniu czytelnego i łatwego do zrozumienia kodu. Dzięki nim programiści mogą pozostawiać notatki i wyjaśnienia dotyczące działania poszczególnych fragmentów kodu, co ułatwia współpracę i późniejsze modyfikacje. W tym artykule omówimy różne rodzaje komentarzy dostępne w Pythonie, podamy najlepsze praktyki ich stosowania oraz zaprezentujemy praktyczne przykłady.

Rodzaje komentarzy w Pythonie

W Pythonie wyróżniamy dwa główne typy komentarzy: jednoliniowe i wieloliniowe.

1. Jednoliniowe komentarze – rozpoczynają się od znaku # i trwają do końca linii. Służą do krótkich wyjaśnień lub tymczasowego wyłączenia fragmentu kodu.
2. Wieloliniowe komentarze – choć Python oficjalnie nie posiada specjalnej składni dla wieloliniowych komentarzy, można ich używać, wykorzystując potrójne cudzysłowy na początku i końcu sekcji komentarza. Technicznie jest to ciąg znaków, ale stosowany jako komentarz, jeśli nie jest przypisany do żadnej zmiennej.

Przykłady użycia komentarzy

# Przykład wykorzystania komentarzy w Pythonie

# Jednoliniowy komentarz wyjaśniający zmienną
number1 = 10  # pierwsza liczba do operacji

number2 = 5  # druga liczba do operacji

# Dodawanie dwóch liczb
sumResult = number1 + number2  # obliczanie sumy
print("Suma:", sumResult)  # wydruk wyniku

"""
Wieloliniowy komentarz służący jako sekcja wyjaśnienia.
Poniższy kod oblicza iloczyn dwóch liczb.
"""
# Mnożenie dwóch liczb
productResult = number1 * number2  # obliczanie iloczynu
print("Iloczyn:", productResult)  # wydruk wyniku

W tym przykładzie:

• Jednoliniowe komentarze używamy do krótkiego wyjaśnienia, co robi dana linijka kodu lub co reprezentuje dana zmienna.
• Wieloliniowy komentarz służy do szerszego wyjaśnienia kolejnej sekcji kodu, w tym przypadku obliczenia iloczynu dwóch liczb. Pomimo że w Pythonie wieloliniowe komentarze są technicznie traktowane jako ciągi znaków, to konwencjonalnie wykorzystuje się je do dokumentacji kodu, szczególnie na początku definicji funkcji, klas, czy większych bloków kodu.

Podsumowanie

Komentarze w kodzie Python pełnią kluczową rolę w utrzymaniu jego czytelności i łatwości zrozumienia. Jak pokazano w prostych przykładach, zarówno jednoliniowe, jak i wieloliniowe komentarze mogą być używane do różnych celów: od wyjaśnienia działania pojedynczych linii kodu, przez zaznaczanie bloków kodu z większym wyjaśnieniem, aż po dokumentowanie całych sekcji kodu.

Jeżeli chcesz przyśpieszyć swoją naukę tworzenia stron chciałbym polecić mój kurs Python od podstaw w którym nauczysz się tego języka od podstaw do zaawansowanych jego aspektów.