Komentarze w Pythonie to linie kodu ignorowane przez interpreter podczas wykonywania programu.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Komentarze zwiększają czytelność kodu i pomagają programistom bardzo dokładnie zrozumieć kod. Pomaga także we współpracy z innymi programistami, ponieważ dodawanie komentarzy ułatwia wyjaśnienie kodu.
Rodzaje komentarzy w Pythonie
W Pythonie istnieją trzy typy komentarzy:
- Komentarze w jednej linii
- Komentarze wielowierszowe
- Literały łańcuchowe
- Komentarze do dokumentacji
Komentarze w Pythonie
Na przykładzie to widać Pyton Komentarze są ignorowane przez interpreter podczas wykonywania programu.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Wyjście:
geeksforgeeks>
Dlaczego w Pythonie używane są komentarze?
Komentarze są integralną częścią języków programowania, a każdy język ma inne sposoby korzystania z komentarzy.
Podobnie jak w każdym innym języku, komentarze w Pythonie służą następującym celom:
- Zwiększ czytelność kodu
- Wyjaśnianie kodu innym
- Zrozumienie kodu, jeśli zostanie przestudiowane po pewnym czasie
- Dokumentowanie kroków i potrzeb funkcji
- Dzielenie się kodem z innymi programistami
- Współpraca z wieloma osobami.
Rodzaje komentarzy w Pythonie
Odkryjmy różne typy komentarzy, jak z nich korzystać i kiedy z nich korzystać?
1. Jednoliniowy Uwagi
- Komentarz jednoliniowy w Pythonie zaczyna się od symbolu hashtagu (#) bez białych spacji i trwa do końca linii.
- Jeśli komentarz przekracza jedną linię, umieść hashtag w następnej linii i kontynuuj komentarz w Pythonie.
- Jednowierszowe komentarze w Pythonie okazują się przydatne do dostarczania krótkich objaśnień zmiennych, deklaracji funkcji i wyrażeń. Zobacz następujący fragment kodu przedstawiający komentarz jednowierszowy:
Przykład:
Python3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
alfabet i cyfry
>
>Wyjście
techcodeview.com>
2. Komentarze wielowierszowe
Python nie udostępnia opcji komentarze wielowierszowe . Istnieją jednak różne sposoby pisania komentarzy wielowierszowych.
a) Komentarze wielowierszowe z użyciem wielu hashtagów (#)
Możemy używać wielu hashtagów (#), aby pisać wielowierszowe komentarze w Pythonie. Każda linia będzie traktowana jako komentarz jednowierszowy.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Wyjście
Multiline comments>
Sprawdź także: Interesujący fakt na temat komentarzy wielowierszowych w Pythonie
3. Literały łańcuchowe
Python ignoruje literały łańcuchowe które nie są przypisane do zmiennej, dzięki czemu możemy używać tych literałów łańcuchowych jako komentarzy w Pythonie .
a) Komentarze jednowierszowe wykorzystujące literały łańcuchowe
Wykonując powyższy kod, widzimy, że nie będzie żadnych wyników, więc używamy ciągów znaków potrójne cytaty () jako komentarze wielowierszowe.
Python3
'This will be ignored by Python'> |
>
>
b) Komentarze wielowierszowe przy użyciu literałów łańcuchowych
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Wyjście
Multiline comments>
4. Dokumentacja
- Dokumentacja Pythona to literały łańcuchowe z potrójnymi cudzysłowami, które pojawiają się zaraz po funkcji.
- Służy do kojarzenia dokumentacji napisanej z modułami, funkcjami, klasami i metodami języka Python.
- Jest dodawany tuż pod funkcjami, modułami lub klasami, aby opisać, co robią. W Pythonie dokumentacja jest następnie udostępniana poprzez atrybut __doc__.
Przykład:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Wyjście:
Multiplies the value of a and b>
Zalety komentarzy w Pythonie
Komentarze są zazwyczaj wykorzystywane w następujących celach:
- Czytelność kodu
- Wyjaśnienie kodu lub metadanych projektu
- Uniemożliwiaj wykonanie kodu
- Aby uwzględnić zasoby
Właściwy sposób pisania komentarzy
Komentarze służą głównie wyjaśnieniu kodu. Programiści stosują zdrowe praktyki pisania komentarzy, aby lepiej zrozumieć kod.
Oto niektóre ze wskazówek, których możesz przestrzegać, aby Twoje komentarze były skuteczne:
- Komentarze powinny być krótkie i precyzyjne.
- Używaj komentarzy tylko wtedy, gdy jest to konieczne, nie zaśmiecaj kodu komentarzami.
- Komentarz powinien mieć jakieś znaczenie.
- Unikaj pisania ogólnych lub podstawowych komentarzy.
- Pisz komentarze, które nie wymagają wyjaśnień.
Omówiliśmy wszystko na temat komentarzy w Pythonie, jak pisać komentarze w Pythonie, rodzaje komentarzy, jakie są ich zalety i właściwy sposób pisania komentarzy.
Przeczytaj także: Jak pisać komentarze w Pythonie3?