Kommentarer og læsbar kode

Kommentarer over flere linjer kan skrives ved hjælp af tre 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 lettere at forstå for andre og for dig selv i fremtiden.
• Fejlfinding og problemløsning.

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

Her er nogle tips 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 lettere at vedligeholde og fejlsøge. Her er nogle tips:

• Brug beskrivende navne til variabler og funktioner.
• Hold kodelinjer korte.
• Organiser koden i sektioner ved hjælp af kommentarer.

Du kan bruge kommentarer til midlertidigt at deaktivere kode i forbindelse med fejlfinding. 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 har du lært:

• Hvordan du skriver kommentarer på én linje og over flere linjer i Python.
• Hvorfor kommentarer er vigtige 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 det næste emne.