Kommentit ja koodin luettavuus

Monirivisiä kommentteja voi kirjoittaa käyttämällä kolmoislainausmerkkejä (''' tai """). Esimerkiksi:

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

Kommentit auttavat seuraavissa asioissa:

• Monimutkaisen koodin selittäminen.
• Koodin tekeminen helpommin ymmärrettäväksi muille ja itsellesi tulevaisuudessa.
• Virheenkorjaus ja ongelmien selvittäminen.

Muista, että kommentit ovat ihmisiä, eivät konetta varten!

Tässä on muutamia vinkkejä hyvien kommenttien kirjoittamiseen:

• Pidätte kommentit ytimekkäinä ja merkityksellisinä.
• Vältätte itsestäänselviä kommentteja, kuten # Increment x by 1 koodille x = x + 1.
• Käytätte kommentteja selittämään, miksi koodi on kirjoitettu tietyllä tavalla.

Helposti luettava koodi on helpompi ylläpitää ja virheenkorjata. Tässä muutamia vinkkejä:

• Käytä kuvaavia muuttujien ja funktioiden nimiä.
• Pidä koodirivit lyhyinä.
• Järjestä koodi osioihin kommenttien avulla.

Voit käyttää kommentteja koodin tilapäiseen poistamiseen käytöstä virheenkorjausta varten. Esimerkiksi:

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

Voit dokumentoida funktioita ja selittää niiden tarkoituksen kommenttien avulla:

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

greet("Alice")

Tässä oppitunnissa opitte:

• Miten Pythonissa kirjoitetaan yksirivisiä ja monirivisiä kommentteja.
• Kommenttien merkityksen koodin luettavuudelle ja ylläpidettävyydelle.
• Kommenttien kirjoittamisen ja koodin luettavuuden parantamisen parhaat käytännöt.

Hienosti tehty! Siirtykäämme seuraavaan aiheeseen.