W tym samouczku nauczymy się tworzyć komentarze w Pythonie za pomocą przykładów.
Wideo: komentarze w Pythonie
Komentarze to opisy, które pomagają programistom lepiej zrozumieć przeznaczenie i funkcjonalność programu.
Są całkowicie ignorowane przez interpreter języka Python.
Zalety używania komentarzy
Używanie komentarzy w programach sprawia, że nasz kod jest bardziej zrozumiały. Dzięki temu program jest bardziej czytelny, co pomaga nam zapamiętać, dlaczego zostały napisane określone bloki kodu.
Poza tym komentarze mogą być również używane do ignorowania niektórych kodów podczas testowania innych bloków kodu. Zapewnia to prosty sposób na zapobieżenie wykonaniu niektórych wierszy lub napisanie szybkiego pseudokodu dla programu.
Komentarze jednowierszowe w Pythonie
W Pythonie używamy symbolu skrótu #do pisania komentarza jednowierszowego.
Przykład 1: Pisanie komentarzy jednowierszowych
# printing a string print('Hello world')
Wynik
Witaj świecie
Tutaj komentarz brzmi:
# printing a string
Ta linia jest ignorowana przez interpreter Pythona.
Wszystko, co przychodzi później, #jest ignorowane. Możemy więc również napisać powyższy program w jednej linii jako:
print('Hello world') #printing a string
Wynik tego programu będzie taki sam, jak w przykładzie 1 . Tłumacz ignoruje cały tekst po #.
Komentarze wieloliniowe w Pythonie
Python nie oferuje oddzielnego sposobu pisania komentarzy wielowierszowych. Istnieją jednak inne sposoby obejścia tego problemu.
Możemy użyć #komentarza na początku każdego wiersza w wielu wierszach.
Przykład 2: Używanie wielu #
# it is a # multiline # comment
Tutaj każda linia jest traktowana jako pojedynczy komentarz i wszystkie są ignorowane.
Literały ciągów dla komentarzy wielowierszowych
Chociaż nie ma unikalnego sposobu pisania komentarzy wielowierszowych w Pythonie, wiemy, że interpreter języka Python ignoruje literały ciągów, które nie są przypisane do zmiennej.
Więc możemy nawet napisać komentarz jednowierszowy jako:
#this is a comment 'this is an unassigned string as a comment '
Tutaj widzimy, że druga linia programu jest łańcuchem, ale nie jest przypisana do żadnej zmiennej ani funkcji. Tak więc interpreter ignoruje ciąg.
W podobny sposób możemy używać ciągów wielowierszowych (potrójnych cudzysłowów) do pisania komentarzy wielowierszowych.
Znak cudzysłowu może być 'albo ".
Przykład 3: Używanie literałów ciągów do pisania komentarzy wieloliniowych
''' I am a multiline comment! ''' print("Hello World")
Tutaj ciąg wielowierszowy nie jest przypisany do żadnej zmiennej, więc jest ignorowany przez interpreter. Mimo że z technicznego punktu widzenia nie jest to komentarz wielowierszowy, można go użyć jako jednego.
Python docstrings
Zgodnie z konwencją, potrójne cudzysłowy, które pojawiają się tuż po definicji funkcji, metody lub klasy, to ciągi dokumentacyjne (ciągi dokumentacji).
Ciągi dokumentów są powiązane z obiektami i można uzyskać do nich dostęp za pomocą __doc__atrybutu.
Aby dowiedzieć się więcej, odwiedź dokumentację języka Python.
Jak pisać lepsze komentarze?
- Użyj komentarzy, aby opisać, co robi funkcja, a nie konkretnych szczegółów dotyczących tego, jak funkcja to robi.
- Spróbuj usunąć jak najwięcej zbędnych komentarzy. Spróbuj napisać kod, który może się wyjaśnić, używając lepszego wyboru nazwy funkcji / zmiennej.
- Postaraj się, aby komentarze były jak najkrótsze i zwięzłe.
