Kommentarer och kodens läsbarhet

Kommentarer används för att förklara kod och göra den mer lättläst. Python-tolken ignorerar dem, och de påverkar inte programmets körning.

I den här lektionen får du lära dig hur du använder kommentarer och skriver ren och lättläst kod.

Kommentarer på en rad börjar med ett #. Allt efter # på den raden ignoreras av Python. Till exempel:

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

Kommentarer över flera rader kan skrivas med trippelcitattecken (''' eller """). Till exempel:

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

Kommentarer hjälper till med:

• Att förklara komplex kod.
• Att göra koden lättare att förstå för andra och för dig själv i framtiden.
• Avlusning och felsökning.

Kom ihåg att kommentarer är till för människor, inte maskiner!

Här är några tips för att skriva bra kommentarer:

• Håll kommentarerna korta och meningsfulla.
• Undvik uppenbara kommentarer som # Increment x by 1 för x = x + 1.
• Använd kommentarer för att förklara varför koden är skriven på ett visst sätt.

Lättläst kod är enklare att underhålla och felsöka. Här är några tips:

• Använd meningsfulla namn på variabler och funktioner.
• Håll kodraderna korta.
• Organisera koden i avsnitt med hjälp av kommentarer.

Du kan använda kommentarer för att tillfälligt inaktivera kod i felsökningssyfte. Till exempel:

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

Du kan använda kommentarer för att dokumentera funktioner och förklara deras syfte:

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

greet("Alice")

I den här lektionen har du lärt dig:

• Hur du skriver kommentarer på en rad och över flera rader i Python.
• Vikten av kommentarer för kodens läsbarhet och underhållbarhet.
• Bästa praxis för att skriva kommentarer och förbättra kodens läsbarhet.

Bra jobbat! Nu går vi vidare till nästa ämne.