I denne opplæringen lærer vi å lage kommentarer i Python ved hjelp av eksempler.
Video: Kommentarer i Python
Kommentarer er beskrivelser som hjelper programmerere å bedre forstå intensjonen og funksjonaliteten til programmet.
De blir fullstendig ignorert av Python-tolk.
Fordeler med å bruke kommentarer
Å bruke kommentarer i programmer gjør koden vår mer forståelig. Det gjør programmet mer lesbart, noe som hjelper oss å huske hvorfor visse kodeblokker ble skrevet.
Annet enn det, kan kommentarer også brukes til å ignorere noen koder mens du tester andre kodeblokker. Dette gir en enkel måte å forhindre utførelse av noen linjer eller skrive en rask pseudokode for programmet.
Enkelts kommentarer i Python
I Python bruker vi hash-symbolet for #å skrive en kommentar med en linje.
Eksempel 1: Skrive kommentarer med en linje
# printing a string print('Hello world')
Produksjon
Hei Verden
Her er kommentaren:
# printing a string
Denne linjen ignoreres av Python-tolk.
Alt som kommer etter #blir ignorert. Så vi kan også skrive programmet ovenfor i en enkelt linje som:
print('Hello world') #printing a string
Resultatet av dette programmet vil være det samme som i eksempel 1 . Tolken ignorerer all teksten etter #.
Flerlinjekommentarer i Python
Python tilbyr ikke en egen måte å skrive kommentarer på flere linjer. Imidlertid er det andre måter å komme seg rundt dette problemet på.
Vi kan bruke #i begynnelsen av hver linje med kommentarer på flere linjer.
Eksempel 2: Bruke flere #
# it is a # multiline # comment
Her blir hver linje behandlet som en enkelt kommentar, og alle blir ignorert.
Strenglitteratur for flerlinjekommentarer
Selv om det ikke er noen unik måte å skrive flerlinjekommentarer i Python, vet vi at Python-tolken ignorerer strenglitteralene som ikke er tilordnet en variabel.
Så vi kan til og med skrive en kommentar med en linje som:
#this is a comment 'this is an unassigned string as a comment '
Her kan vi se at den andre linjen i programmet er en streng, men ikke er tildelt noen variabel eller funksjon. Så, tolken ignorerer strengen.
På en lignende måte kan vi bruke flerlinjestrenger (trippel anførselstegn) for å skrive flerlinjekommentarer.
Sitattegnet kan enten være 'eller ".
Eksempel 3: Bruke strenglitteratur til å skrive kommentarer med flere linjer
''' I am a multiline comment! ''' print("Hello World")
Her er ikke multilinjestrengen tildelt noen variabel, så den ignoreres av tolken. Selv om det teknisk ikke er en flerlinjekommentar, kan den brukes som en.
Python docstrings
Etter konvensjon er de trippel sitatene som vises rett etter funksjonen, metoden eller klassedefinisjonen dokstrings (dokumentasjonsstrenger).
Docstrings er knyttet til objekter og kan nås ved hjelp av __doc__attributtet.
For å lære mer, besøk Python docstrings.
Hvordan skrive bedre kommentarer?
- Bruk kommentarer til å beskrive hva en funksjon gjør og ikke de spesifikke detaljene om hvordan funksjonen gjør det.
- Prøv å fjerne så mange overflødige kommentarer som mulig. Prøv å skrive kode som kan forklare seg selv, ved å bruke bedre funksjon / valg av variabelnavn.
- Prøv å gjøre kommentarene så korte og konsise som mulig.
