I denne vejledning lærer vi at oprette kommentarer i Python ved hjælp af eksempler.
Video: Kommentarer i Python
Kommentarer er beskrivelser, der hjælper programmører bedre med at forstå programmets hensigt og funktionalitet.
De ignoreres fuldstændigt af Python-tolken.
Fordele ved at bruge kommentarer
Brug af kommentarer i programmer gør vores kode mere forståelig. Det gør programmet mere læsbart, hvilket hjælper os med at huske, hvorfor visse kodeblokke blev skrevet.
Bortset fra det kan kommentarer også bruges til at ignorere nogle koder, mens de tester andre blokke af kode. Dette giver en enkel måde at forhindre udførelsen af nogle linjer eller skrive en hurtig pseudokode til programmet.
Enkeltlinjekommentarer i Python
I Python bruger vi hash-symbolet #til at skrive en kommentar med en linje.
Eksempel 1: Skrivning af enkeltlinjekommentarer
# printing a string print('Hello world')
Produktion
Hej Verden
Her er kommentaren:
# printing a string
Denne linje ignoreres af Python-tolken.
Alt, hvad der kommer efter #, ignoreres. Så vi kan også skrive ovenstående program i en enkelt linje som:
print('Hello world') #printing a string
Output fra dette program vil være det samme som i eksempel 1 . Tolken ignorerer al teksten efter #.
Flere linjekommentarer i Python
Python tilbyder ikke en separat måde at skrive flerlinjekommentarer på. Der er dog andre måder at komme rundt på dette problem.
Vi kan bruge #i begyndelsen af hver kommentarlinje på flere linjer.
Eksempel 2: Brug af flere #
# it is a # multiline # comment
Her behandles hver linje som en enkelt kommentar, og alle ignoreres.
Strenglitteratur til kommentarer med flere linjer
Selvom der ikke er nogen unik måde at skrive flerlinjekommentarer i Python, ved vi, at Python-tolken ignorerer strenglitteraturerne, der ikke er tildelt en variabel.
Så vi kan endda 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 anden linje i programmet er en streng, men ikke er tildelt nogen variabel eller funktion. Så tolken ignorerer strengen.
På en lignende måde kan vi bruge multiline strenge (triple citater) til at skrive multiline kommentarer.
Citattegnet kan enten være 'eller ".
Eksempel 3: Brug af strenglitteratur til at skrive kommentarer med flere linjer
''' I am a multiline comment! ''' print("Hello World")
Her er multilinjestrengen ikke tildelt nogen variabel, så den ignoreres af tolken. Selvom det teknisk set ikke er en multiline-kommentar, kan den bruges som en.
Python docstrings
Efter konvention er de tredobbelte citater, der vises lige efter funktionen, metoden eller klassedefinitionen, dokstrings (dokumentationsstrenge).
Docstrings er knyttet til objekter og kan tilgås ved hjælp af __doc__attributten.
Hvis du vil vide mere, skal du besøge Python docstrings.
Hvordan man skriver bedre kommentarer?
- Brug kommentarer til at beskrive, hvad en funktion gør, og ikke de specifikke detaljer om, hvordan funktionen gør det.
- Prøv at fjerne så mange overflødige kommentarer som muligt. Prøv at skrive kode, der kan forklare sig selv ved hjælp af bedre valg af valg af funktion / variabel.
- Prøv at gøre kommentarerne så korte og koncise som muligt.
