Kommentarer og lesbar kode

Kommentarer brukes til å forklare kode og gjøre den mer lesbar. Python-tolken ignorerer dem, og de påvirker ikke kjøringen av programmet.

I denne leksjonen lærer du hvordan du bruker kommentarer og skriver ryddig, lesbar kode.

Kommentarer på én linje begynner med #. Alt etter # på den aktuelle linjen ignoreres av Python. For eksempel:

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

Kommentarer over flere linjer kan skrives ved hjelp av tre enkle eller doble anførselstegn (''' eller """). For eksempel:

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

Kommentarer hjelper med:

• Å forklare kompleks kode.
• Å gjøre koden enklere å forstå for andre og for deg selv senere.
• Feilsøking og problemløsing.

Husk at kommentarer er for mennesker, ikke for maskinen!

Her er noen tips for å skrive gode kommentarer:

• Hold kommentarene korte og meningsfulle.
• Unngå åpenbare kommentarer som # Increment x by 1 for x = x + 1.
• Bruk kommentarer til å forklare hvorfor koden er skrevet på en bestemt måte.

Lesbar kode er enklere å vedlikeholde og feilsøke. Her er noen tips:

• Bruk meningsfulle navn på variabler og funksjoner.
• Hold kodelinjene korte.
• Organiser koden i seksjoner ved hjelp av kommentarer.

Du kan bruke kommentarer til å deaktivere kode midlertidig for feilsøkingsformål. For eksempel:

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

Du kan bruke kommentarer til å dokumentere funksjoner og forklare formålet med dem:

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

greet("Alice")

I denne leksjonen har du lært:

• Hvordan du skriver kommentarer på én linje og over flere linjer i Python.
• Hvor viktig kommentarer er for kodens lesbarhet og vedlikehold.
• Beste praksis for å skrive kommentarer og forbedre kodens lesbarhet.

Bra jobbet! La oss gå videre til neste emne.