Komentarz to fragment kodu źródłowego ignorowany przez interpreter. Służy do opisywania działania programu, wyjaśniania trudniejszych fragmentów kodu albo tymczasowego wyłączania pojedynczych instrukcji podczas testowania.
Komentarz jednoliniowy
W Pythonie komentarz jednoliniowy rozpoczyna się znakiem #. Wszystko od tego znaku do końca linii jest traktowane jako komentarz.
# To jest komentarz jednoliniowy
print("Hello, world!") # komentarz może być też po instrukcji
W pytaniu egzaminacyjnym poprawną odpowiedzią jest więc #.
Czy Python ma komentarze wieloliniowe?
Python nie ma osobnej składni komentarza blokowego takiej jak /* ... */ w C/C++/JavaScript. W praktyce stosuje się kilka linii zaczynających się od #:
# Ten fragment opisuje działanie funkcji
# i zajmuje więcej niż jedną linię.
# Każda linia zaczyna się od znaku #.
Czasem do dłuższych opisów używa się potrójnych cudzysłowów ''' ... ''' lub """ ... """, ale formalnie są to napisy wieloliniowe, a nie komentarze. Jeśli nie zostaną przypisane do zmiennej, interpreter zwykle je ignoruje, lecz nie należy mylić ich z komentarzem.
Dobre praktyki
- komentarz powinien wyjaśniać „dlaczego”, a nie powtarzać oczywistego kodu,
- nie należy przesadzać z liczbą komentarzy,
- komentarze trzeba aktualizować razem ze zmianami w kodzie,
- do dokumentowania funkcji i klas używa się docstringów, czyli napisów dokumentacyjnych.
Przykład
def pole_kwadratu(a):
# Wzór na pole kwadratu: a * a
return a * a
Najważniejsze do zapamiętania: komentarz jednoliniowy w Pythonie zaczyna się od znaku #.