Wprowadzenie do komentarzy i czytelności kodu

Komentarze służą do wyjaśniania kodu i zwiększania jego czytelności. Interpreter Pythona ignoruje komentarze, więc nie wpływają one na wykonanie programu.

W tej lekcji nauczą się Państwo używać komentarzy oraz pisać przejrzysty i czytelny kod.

Komentarze jednowierszowe

Komentarze jednowierszowe zaczynają się od znaku #. Wszystko, co znajduje się za znakiem # w danym wierszu, jest ignorowane przez Python. Na przykład:

# This is a single-line comment
print("Hello, World!")

Komentarze wielowierszowe

Komentarze wielowierszowe można zapisywać za pomocą potrójnych cudzysłowów (''' lub """). Na przykład:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Dlaczego używać komentarzy?

Komentarze pomagają w:

• Wyjaśnianiu złożonego kodu.
• Ułatwianiu zrozumienia kodu innym osobom oraz sobie w przyszłości.
• Debugowaniu i rozwiązywaniu problemów.

Należy pamiętać, że komentarze są przeznaczone dla ludzi, a nie dla maszyny!

Dobre praktyki dotyczące komentarzy

Oto kilka wskazówek dotyczących pisania dobrych komentarzy:

• Proszę pisać komentarze zwięzłe i znaczące.
• Proszę unikać oczywistych komentarzy, takich jak # Increment x by 1 dla instrukcji x = x + 1.
• Proszę używać komentarzy do wyjaśniania, dlaczego kod został napisany w określony sposób.

Zwiększanie czytelności kodu

Czytelny kod jest łatwiejszy w utrzymaniu i debugowaniu. Oto kilka wskazówek:

• Należy używać znaczących nazw zmiennych i funkcji.
• Należy ograniczać długość wierszy kodu.
• Należy organizować kod w sekcje za pomocą komentarzy.

Wyłączanie kodu za pomocą komentarzy

Za pomocą komentarzy można tymczasowo wyłączyć kod na potrzeby debugowania. Na przykład:

# print("This line is commented out and won’t run.")
print("This line will run.")

Przykład: dokumentowanie funkcji

Za pomocą komentarzy można opisywać funkcje i wyjaśniać ich przeznaczenie:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

Czego się nauczyliśmy?

W tej lekcji nauczyli się Państwo:

• Jak pisać komentarze jedno- i wielowierszowe w języku Python.
• Jakie znaczenie mają komentarze dla czytelności i łatwości utrzymania kodu.
• Jakie są dobre praktyki pisania komentarzy i zwiększania czytelności kodu.

Świetna praca! Przejdźmy do następnego tematu.