Kommentarer og læsbar kode

Kommentarer bruges til at forklare kode og gøre den mere læsbar. Python-fortolkeren ignorerer dem, og de påvirker ikke programmets kørsel.

I denne lektion lærer du, hvordan du bruger kommentarer og skriver ren, læsbar kode.

Kommentarer på én linje begynder med et #. Alt efter # på den pågældende linje ignoreres af Python. For eksempel:

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

Kommentarer over flere linjer kan skrives ved hjælp af tredobbelte anførselstegn (''' eller """). For eksempel:

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

Kommentarer hjælper med:

• At forklare kompleks kode.
• At gøre kode nemmere at forstå for andre og for dig selv i fremtiden.
• Fejlsøgning og fejlfinding.

Husk, at kommentarer er til mennesker, ikke til maskinen!

Her er nogle tip til at skrive gode kommentarer:

• Hold kommentarerne korte og meningsfulde.
• Undgå indlysende kommentarer som # Increment x by 1 til x = x + 1.
• Brug kommentarer til at forklare, hvorfor koden er skrevet på en bestemt måde.

Læsbar kode er nemmere at vedligeholde og fejlsøge. Her er nogle tip:

• Brug meningsfulde variabel- og funktionsnavne.
• Hold kodelinjer korte.
• Organiser koden i sektioner ved hjælp af kommentarer.

Du kan bruge kommentarer til midlertidigt at deaktivere kode med henblik på fejlsøgning. For eksempel:

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

Du kan bruge kommentarer til at dokumentere funktioner og forklare deres formål:

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

greet("Alice")

I denne lektion lærte du:

• Hvordan du skriver kommentarer på én linje og over flere linjer i Python.
• Vigtigheden af kommentarer for kodens læsbarhed og vedligeholdelse.
• Bedste praksis for at skrive kommentarer og forbedre kodens læsbarhed.

Godt gået! Lad os gå videre til næste emne.