Kommentarer i Python er linjene i koden som ignoreres av tolken under kjøringen av programmet.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Kommentarer forbedrer kodens lesbarhet og hjelper programmererne til å forstå koden veldig nøye. Det hjelper også med å samarbeide med andre utviklere ettersom å legge til kommentarer gjør det lettere å forklare koden.
Typer kommentarer i Python
Det er tre typer kommentarer i Python:
- Enkeltlinjekommentarer
- Flerlinjekommentarer
- Strengbokstaver
- Docstring-kommentarer
Kommentarer i Python
I eksemplet kan det sees at Python Kommentarer ignoreres av tolken under kjøringen av programmet.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Produksjon:
geeksforgeeks>
Hvorfor brukes kommentarer i Python?
Kommentarer har vært en integrert del av programmeringsspråk, og hvert språk har forskjellige måter å bruke kommentarer på.
Akkurat som alle andre språk, tjener kommentarer i Python følgende formål:
- Forbedre kodelesbarheten
- Forklarer koden til andre
- Forstå kode hvis studert etter en tid
- Dokumentere trinn og behov for en funksjon
- Deler kode med andre utviklere
- Samarbeide med flere personer.
Typer kommentarer i Python
La oss oppdage de forskjellige typene kommentarer, hvordan bruker de og når de skal brukes?
1. Enkeltlinje Kommentarer
- Python enlinjekommentar starter med hashtag-symbolet (#) uten mellomrom og varer til slutten av linjen.
- Hvis kommentaren overskrider én linje, sett en hashtag på neste linje og fortsett Python-kommentaren.
- Pythons enkeltlinjekommentarer har vist seg nyttige for å gi korte forklaringer for variabler, funksjonserklæringer og uttrykk. Se følgende kodebit som demonstrerer kommentar på én linje:
Eksempel:
Python3
strengbygger java
java oppslag
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Produksjon
techcodeview.com>
2. Kommentarer med flere linjer
Python gir ikke muligheten til flerlinjekommentarer . Det er imidlertid forskjellige måter vi kan skrive kommentarer med flere linjer på.
a) Flerlinjekommentarer med flere hashtags (#)
Vi kan flere hashtags (#) for å skrive flerlinjekommentarer i Python. Hver eneste linje vil bli betraktet som en enkeltlinjekommentar.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Produksjon
Multiline comments>
Sjekk også: Interessant fakta om Python Multi-line Kommentarer
3. Strengbokstaver
Python ignorerer streng bokstaver som ikke er tilordnet en variabel, slik at vi kan bruke disse strengliteralene som Python-kommentarer .
a) Enkeltlinjekommentarer ved bruk av strengbokstaver
Ved å utføre koden ovenfor kan vi se at det ikke vil være noen utgang, så vi bruker strengene med trippel sitater () som flerlinjekommentarer.
Python3
'This will be ignored by Python'> |
>
>
b) Flerlinjekommentarer ved bruk av strengbokstaver
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
lateksmatrise
>Produksjon
Multiline comments>
4. Docstring
- Python docstring er strengbokstavene med tredoble anførselstegn som vises rett etter funksjonen.
- Den brukes til å knytte dokumentasjon som er skrevet med Python-moduler, funksjoner, klasser og metoder.
- Det legges til rett under funksjonene, modulene eller klassene for å beskrive hva de gjør. I Python blir docstringen deretter gjort tilgjengelig via __doc__-attributtet.
Eksempel:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Produksjon:
Multiplies the value of a and b>
Fordeler med kommentarer i Python
Kommentarer brukes vanligvis til følgende formål:
- Kode lesbarhet
- Forklaring av koden eller metadata for prosjektet
- Forhindre kjøring av kode
- Å inkludere ressurser
Riktig måte å skrive kommentarer på
Kommentarer tjener hovedformålet å forklare koden din. Utviklere bruker sunn praksis for å skrive kommentarer for bedre forståelse av koden.
Noen av tipsene du kan følge for å gjøre kommentarene dine effektive er:
- Kommentarer bør være korte og presise.
- Bruk kommentarer bare når det er nødvendig, ikke fyll koden din med kommentarer.
- Kommentar bør ha en viss mening.
- Unngå å skrive generelle eller grunnleggende kommentarer.
- Skriv kommentarer som er selvforklarende.
Vi har diskutert alt om Python-kommentarer, hvordan du skriver Python-kommentarer, typer kommentarer, hva er fordelene og den riktige måten å skrive kommentarer på.
Les også: Hvordan skrive kommentarer i Python3?