W Pythonie komentarze służą do wyjaśniania kodu, czyniąc go bardziej zrozumiałym dla ludzi. Choć Python nie wspiera wieloliniowych komentarzy w taki sposób, jak niektóre inne języki programowania, oferuje prosty mechanizm do osiągnięcia podobnego efektu. W tym artykule wyjaśnimy, jak używać ciągów znaków (stringów) do tworzenia wieloliniowych komentarzy w Pythonie i zaprezentujemy kompletny przykład użycia takiej techniki.
Przykład kodu z wieloliniowym komentarzem
# Definiowanie funkcji say_hello
def say_hello(name):
# Wieloliniowy komentarz wyjaśniający działanie funkcji
"""
Funkcja say_hello przyjmuje jeden argument - name.
Wyświetla ona przywitanie, dodając do niego wartość
zmiennej name.
"""
# Wyświetlanie powitania z imieniem
print("Hello, " + name + "!")
# Wywołanie funkcji say_hello
say_hello("Alice")
W tym przykładzie użyliśmy trzykrotnego cudzysłowu (""") do stworzenia wieloliniowego komentarza, który wyjaśnia działanie funkcji say_hello. Jest to standardowa praktyka w Pythonie do dokumentowania działań funkcji, klas, modułów itd.
Jak to działa?
Python posiada dwa sposoby na dodawanie komentarzy do kodu:
- Jednoliniowe komentarze – używane są do krótkich wyjaśnień kodu i rozpoczynają się od znaku
#. Każda linia komentarza musi zaczynać się od nowego znaku#. - Wieloliniowe komentarze – w Pythonie nie istnieje specjalny składnik języka przeznaczony wyłącznie do tworzenia wieloliniowych komentarzy, tak jak w niektórych innych językach programowania. Zamiast tego, do osiągnięcia tego efektu, używa się trzykrotnych cudzysłowów (
"""lub'''). Technicznie jest to wieloliniowy ciąg znaków, ale gdy nie jest przypisany do zmiennej ani używany w wyrażeniu, Python traktuje go jako komentarz.
Kiedy używać wieloliniowych komentarzy?
Wieloliniowe komentarze są szczególnie przydatne, gdy potrzebujesz wyjaśnić bardziej złożone części kodu, takie jak logika funkcji, algorytmy, lub gdy dokumentujesz kod za pomocą docstrings. Umożliwiają one zachowanie czytelności kodu i są łatwe do zauważenia, dzięki czemu inni programiści mogą szybko zrozumieć zamysł danego fragmentu kodu.
Podsumowanie
Wieloliniowe komentarze w Pythonie są realizowane poprzez użycie trzykrotnych cudzysłowów, które technicznie tworzą wieloliniowy ciąg znaków. Choć Python nie posiada dedykowanego mechanizmu do tworzenia wieloliniowych komentarzy, ta metoda jest szeroko akceptowana i używana w praktyce programistycznej. Ułatwia ona dokumentowanie kodu, czyniąc go bardziej przystępnym i zrozumiałym dla innych programistów.
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.