Dzisiaj temat lekki i przyjemny jeśli chodzi o Pythona 😄. Pokażę Ci jak tworzyć komentarze w języku Python, jakie jest ich zastosowanie w kodzie, a także czym się różni komentarz liniowy od blokowego 🔥. Zapraszam 😊!
PRZEDSTAWIAM KOMENTARZE W JĘZYKU PYTHON!
Na początek wyjaśnię sam termin 🙂.
CZYM JEST KOMENTARZ W JĘZYKU PYTHON?
W Pythonie, komentarz jest fragmentem kodu, który nie jest brany pod uwagę przez interpreter ℹ️. W jego obrębie możemy pisać dowolne hasła wykraczające poza składnię języka. Stosowany jest w celu pozostawienia wyjaśnień bądź ważnych adnotacji danego fragmentu kodu źródłowego 💡.
Dzięki temu, możemy zostawić dla reszty zespołu notatkę co ten fragment robi czy też w jakim celu występuje dana zmienna i dlaczego ma taki typ danych, a nie inny 👍.
JAKIE SĄ RODZAJE KOMENTARZY W JĘZYKU PYTHON?
Python posiada 2 rodzaje komentarzy jakie możemy stosować w kodzie 👇:
- komentarz liniowy,
- komentarz blokowy.
Oba rodzaje różnią się między sobą zapisem i zastosowaniem 🙂. Teraz Ci je zaprezentuję 🚀!
JAK DODAĆ KOMENTARZ LINIOWY W JĘZYKU PYTHON?
Komentarz liniowy tworzymy poprzez wstawienie znaku krzyżyka (ang. hash) 👇:
# Komentarz liniowyJak wynika z nazwy, obejmuje tylko jeden wiersz kodu 😉. Tuż po znaku, możesz pisać co tylko Ci się podoba i Python zignoruje tę treść 👍.
Możesz w ten sposób zakomentować różne instrukcje kodu, aby na jakiś czas się nie wykonywały, na przykład 👇:
#print('Mój łańcuch znaków')Gdy umieścisz krzyżyk przed instrukcją, nieuwzględnianie kodu obejmie również tę instrukcję 🔥!
Ponieważ jest to komentarz liniowy, to całe pomijanie kodu będzie dotyczyć tylko tego wiersza ⚠️!
A teraz drugi rodzaj komentarza: blokowy!
JAK DODAĆ KOMENTARZ BLOKOWY W JĘZYKU PYTHON?
Komentarz blokowy (nazywany też wielowierszowym czy wielolinijkowym ℹ️) wymaga już odmiennego sposobu zapisu, jako że pozwala na zignorowanie WIELU wierszy kodu na kształt "obszaru" do pominięcia 🔥.
Symbolem komentarza blokowego są 3 apostrofy bez spacji 👇:
'''Ponieważ komentarz blokowy dotyczy wielu linijek kodu, musimy taki sam symbol dodać drugi raz, w miejscu w którym ma się zakończyć wyznaczanie komentarza 😲! Czyli wyznaczamy początek i koniec 🎯.
To jest przykład 👇:
'''
Komentarz
blokowy
'''W pierwszym wierszu mamy 3 apostrofy oznaczające początek traktowania kodu jako komentarza blokowego, następnie w dwóch kolejnych wierszach mamy hasła tekstu, a ostatni wiersz posiada drugie takie same 3 apostrofy oznaczające koniec komentarza blokowego 😅!
Ważna rzecz co do stawianych znaków ⚠️! Możesz wiedzieć lub nie, lecz Python wyróżnia się na tle innych języków oryginalną składnią i dotyczy to również komentarzy 😳! Tutaj masz znak krzyżyka i apostrofu, lecz na przykład w Javie (i wielu innych językach) komentarze liniowe tworzy się za pomocą dwóch ukośników, a blokowe przy użyciu kombinacji: ukośnik + asterysk (lub na odwrót, jeśli ma oznaczać koniec komentarza blokowego ℹ️) 😱!
Piszę o tym, abyś nie był(a) później zaskoczony(-a) dostrzeżeniem całkiem innego sposobu zapisu!
CZY WARTO DODAWAĆ KOMENTARZE W JĘZYKU PYTHON?
Zależy wyłącznie od Ciebie 🫵. Komentarze mogą być pomocne w momencie, gdy jeszcze się uczysz programowania i potrzebujesz zostawić sobie tłumaczenie pewnych części kodu, aby móc wrócić do niego po dłuższym czasie i wiedzieć o co chodzi 👍. Natomiast w mojej ocenie, dużo lepiej zamienić stosowanie komentarzy w kodzie na pisanie takiego kodu, który on sam wszystko wyjaśnia i nie wymaga użycia abstrakcyjnego języka (tak, da się tak pisać kod 😝) ❤️.
Zostawianie komentarzy powoduje ryzyko, że po zmianie kodu zapomnisz zaktualizować ten komentarz, przez co później będzie napisane coś, co mija się z prawdą 😐. A wbrew pozorom, jednoznaczność jest bardzo istotna w programowaniu 💥!
Najlepiej jak zdecydujesz samodzielnie, po pewnym czasie praktyki. Nie piszę, że komentarze są dobre albo złe, tylko napisałem zaletę i wadę ich stosowania 😉.
 |
Komentarze w języku Python służą do pozostawiania wyjaśnień poszczególnych fragmentów kodu źródłowego pisanych językiem abstrakcyjnym (poza składnią języka), które mają nie być uwzględniane przez interpreter. Dzielą się na komentarze liniowe i blokowe.
Koniec! Widzisz sam(a), że szybko poszło 😁.