Python: komentowanie kodu (komentarze)

Komentowanie kodu może okazać się przydatne szczególnie wtedy, gdy kod danego programu czy aplikacji jest długi i niezrozumiały. Na tym etapie warto zaznaczyć, że kod powinno się pisać w taki sposób, aby był w pełni zrozumiały dla innych programistów. Czasami warto jednak dodać kilka słów wyjaśnienia w komentarzu. W tym artykule zajmiemy się sposobami komentowania kodu w języku python.

Czym jest komentowanie kodu?

W skrócie rzecz ujmując komentowanie kodu jest po to, aby poinformować siebie lub innych programistów o tym co dokładnie znajduje się w danym fragmencie kodu. Ale to nie jedyny powód używania komentarzy.

Być może będziesz chciał przetestować jakieś konkretne fragmenty kodu. Wówczas za pomocą komentarzy możesz wyłączyć określone fragmenty z kompilacji. We wszystkich liniach, które nie mają być poddane wykonaniu – dodaj znak komentarza, a dana linia kodu się po prostu nie wywoła. Gdy już wprowadzisz odpowiednie zmiany, możesz ten fragment odkomentować.

Jak wygląda komentarz w języku python?

Za tworzenie komentarzy w języku python odpowiada znak #. W języku polskim bywa nazywany płotkiem, krzyżykiem lub kratką (z ang. hash). Aby rozpocząć komentarz w pythonie należy po prostu użyć znaku #. Wszystko od znaku # do końca linii interpreter pythona traktuje jako komentarz.

Jednolinijkowy komentarz w pythonie

# to jest jednolinijkowy komentarz

Komentarz można również dodać obok kodu, na przykład w postaci:

print("Hello World!") # powitanie

Wielolinijkowy komentarz w pythonie

# to jest komentarz
# złożony z kilku
# wierszy

Stosowanie wieloliniowych komentarzy jest bardzo przydatne szczególnie wtedy, gdy chcemy umieścić w komentarzu nieco więcej informacji.

Kolorowanie składni komentarza

Warto wyposażyć się w narzędzie do edycji kodu, dzięki czemu będziesz miał pokolorowaną składnię komentarzy. I tak – np. Visual Studio Code domyślnie zaznacza komentarz na zielono, co jest od razu widoczne przy otwarciu pliku. Czasami określone fragmenty kodu znajdują się w komentarzu – wówczas zmieniony kolor pozwala bardzo szybko zauważyć, które elementy kodu nie zostaną wykonane.

Skróty klawiaturowe do komentarzy

Skróty klawiaturowe są bardzo przydatne przy pisaniu kodu. Za tworzenie komentarzy odpowiedzialny jest skrót Ctrl + /. Naciśnięcie na klawiaturze tych dwóch znaków spowoduje dodanie # w liniach, które są zaznaczone.

Możesz zaznaczyć jedną linię lub kilka. Dzięki temu skrótowi możesz bardzo łatwo zaznaczać większe fragmenty kodu. Rozwiązanie to działa zarówno w Viusal Studio Code jak i PyCharm.

Dodawanie komentarza poprzez zaznaczanie większego bloku kodu:

  • Najpierw zaznaczamy blok kodu za pomocą myszki (przytrzymując lewy guzik) lub wykorzystując Shift + strzałka.
  • Następnie używamy na zaznaczonym bloku Ctrl + / (hashe pojawią się na początku każdej linii zaznaczonego kodu).
  • Jeśli chcemy odkomentować kod, wystarczy ponownie wcisnąć Ctrl + /.

Podsumowanie

Twój kod powinien być jak najbardziej czytelny. Najlepiej ograniczać liczbę komentarzy, które zbędnie wydłużają kod. Wszelkie zmienne, funkcje najlepiej tworzyć w taki sposób, aby były zrozumiałe dla innych programistów. Jeśli więc obliczasz np. liczbę słów w tekście – zmienna zliczająca słowa może nazywać się words. Jeśli obliczasz liczbę znaków – zmienna może się nazywać characters. Wówczas zmienne będą zrozumiałe i nie trzeba ich dodatkowo komentować.

Komentowanie kodu w pythonie jest bardzo proste. Wystarczy umieścić znak płotka #. Cała treść po hashu zostanie uznana przez pythona za komentarz, co równocześnie oznacza, że jeśli w komentarzu znajduje się kod – zostanie on wyłączony z kompilacji. Warto zapamiętać również skrót Ctrl + /. Tym skrótem klawiszowym możesz bardzo szybko zaznaczać i odznaczać poszczególne fragmenty kodu (dodając lub usuwając komentarz).

Popularne zapytania: python komentarze, blokowe, wieloliniowe, wielowierszowe, wielolinijkowe, długie komentarze w pythonie, tworzenie kodu komentarze, komentarz blokowy, edytuj kod komentarza, komentarz python, komentarze wieloliniowe w pythonie.