W naszym kursie nadszedł czas na kilka ważnych rzeczy, które już na tym początkowym etapie powinny być omówione. One wiele razy pewnie się będą jeszcze przewijać. Są to pewny ważne koncepcje, ważne techniki pracy, które powinieneś znać jako programista Python. Pierwsza ważna rzecz, to użycie komentarzy.
Komentarze w kodzie pełnią niezwykle ważną rolę, za ich pomocą opisujemy jaką rolę pełni dana część kodu, w jaki sposób działa. Wyjaśniamy pewne szczegóły dotyczące działania. Chodzi o to by podnieść poziom zrozumienia takiego kodu. Jest to niezwykle ważne czy tworzymy programy samodzielnie, czy też pracujemy w zespole. Zawsze trzeba jak najwięcej komentarzy stosować, opisywać w miarę możliwości każdą część programu, która takiego opisania po prostu wymaga. Pewne podstawowe techniki tworzenia komentarzy właśnie dziś sobie pokażemy.
Technik wstawiania komentarzy nie ma za wiele, bowiem tak właściwie w Pythonie mamy jeden, podstawowy, komentarz jednoliniowy. Rozpoczynamy taki komentarz od znaku hash, a po nim wpisujemy treść komentarza, jak pokazano niżej.
Taka linia będzie ignorowana, właśnie dlatego, że na jej początku znajduje się znak hash, to co znajduje się po tym znaku będzie ignorowane przez interpreter Pythona. Poniżej można sobie już wprowadzać zwykły, interpretowany przez interpreter kod Pythona.
Natomiast to co jest w linii pierwszej, zostanie podczas wykonywania programu zignorowane. Przykładowo jeśli w treście komentarza wpiszemy print(x) to interpreter i tak nie będzie zwracał na to uwagi, tylko wykona kod pod spodem, poza komentarzem.
Komentarz służy po prostu po to by w jakiś sposób opisać ten nasz kod i jest przez interpreter ignorowany, jak i nie widać go nigdzie prócz kodu programu.
Kilka linii komentarza
Jak wstawić kilka linii komentarza? Po prostu wstawiamy kolejne linie zaczynające się od znaku hash.
Powyżej, na grafice, mamy do czynienia po prostu z trzema komentarzami jednoliniowymi, których możemy użyć jeśli potrzebujemy jakiegoś dłuższego komentarza.
Mamy też możliwość tworzenia komentarzy śródliniowych, to znaczy obok kodu.
Przykładowo w piątej linii możemy na końcu wstawić znak # i dopisać tekst "to jest funkcja print()" i będzie to również przez interpreter pomijane, jako komentarz. Czyli wszystko co znajdzie się po znaku hash, zostaje zignorowane. Natomiast to co znajduje się przed wspomnianym znakiem, zostanie prawidłowo zinterpretowane.
Czyli mamy komentarz zajmujący całą linię i tak zwany komentarz śród liniowy, który umieszczany jest obok kodu, by wyjaśnić jakiś krótki fragment kodu umieszczony obok.
Jeśli chodzi jeszcze o komentarze wieloliniowe, to w Pythonie mamy dość proste podejście. Mamy tylko komentarze jednoliniowe, jeśli chcemy dodać kilka linii pod rząd, to musimy każdą linię rozpocząć od hash. Czasem się zdarza, że niektórzy symulują komentarze wieloliniowe, za pomocą tak zwanego wieloliniowego string. Wieloliniowe string tworzymy tak, że zaczynamy i kończymy je potrójnym apostrofem.
Jest to taki string, który obejmuje kilka linii, tak jak mówiliśmy - niektórzy w ten sposób symulują komentarze wieloliniowe, ale nie zmienia to faktu, że taki kod zostanie odczytany i zinterpretowany przez interpreter. Nie jest to poprawny komentarz Pythona. Poprawny komentarz Pythona jest zawsze jednoliniowy i zawsze rozpoczyna się od hash.
W niektórych edytorach można sobie uprościć pracę, jeśli rzeczywiście chcemy szybko zamienić kilka linii tekstu na komentarz, to często po zaznaczeniu takich linii mamy do dyspozycji skrót, który to za nas robi. Z technicznego punktu widzenia, będzie to wciąć kilka komentarzy jednoliniowych pod rząd, ale bardzo przyśpiesza to pracę, ponieważ w jednej operacji zamienia wiele linii, na kolejno następujące po sobie komentarze jednoliniowe.