Kommentarer i Python er linjerne i koden, der ignoreres af tolken under afviklingen af programmet.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Kommentarer forbedrer kodens læsbarhed og hjælper programmørerne til at forstå koden meget omhyggeligt. Det hjælper også med at samarbejde med andre udviklere, da tilføjelse af kommentarer gør det lettere at forklare koden.
Typer af kommentarer i Python
Der er tre typer kommentarer i Python:
- Enkelt linje kommentarer
- Multiline kommentarer
- Streng bogstaver
- Docstring-kommentarer
Kommentarer i Python
I eksemplet kan det ses Python Kommentarer ignoreres af tolken under afviklingen af programmet.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Produktion:
geeksforgeeks>
Hvorfor bruges kommentarer i Python?
Kommentarer har været en integreret del af programmeringssprog, og hvert sprog har forskellige måder at bruge kommentarer på.
Ligesom ethvert andet sprog tjener kommentarer i Python følgende formål:
- Forbedre kodelæsbarhed
- Forklar kode til andre
- Forståelse af kode, hvis den studeres efter nogen tid
- Dokumentation af trin og behov for en funktion
- Deler kode med andre udviklere
- Samarbejde med flere mennesker.
Typer af kommentarer i Python
Lad os opdage de forskellige typer kommentarer, hvordan man bruger dem, og hvornår skal man bruge dem?
1. Enkeltlinje Kommentarer
- Python-enkeltlinjekommentar starter med hashtag-symbolet (#) uden mellemrum og varer til slutningen af linjen.
- Hvis kommentaren overstiger én linje, så sæt et hashtag på den næste linje og fortsæt Python-kommentaren.
- Pythons enkeltlinjekommentarer har vist sig at være nyttige til at levere korte forklaringer til variabler, funktionserklæringer og udtryk. Se følgende kodestykke, der demonstrerer en enkelt linjekommentar:
Eksempel:
Python3
react js tutorial
java enums
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Produktion
techcodeview.com>
2. Kommentarer med flere linjer
Python giver ikke mulighed for multiline kommentarer . Der er dog forskellige måder, hvorpå vi kan skrive kommentarer med flere linier.
a) Flerlinjekommentarer ved hjælp af flere hashtags (#)
Vi kan bruge flere hashtags (#) for at skrive kommentarer med flere linjer i Python. Hver eneste linje vil blive betragtet som en enkeltlinjekommentar.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Produktion
Multiline comments>
Tjek også: Interessant fakta om Python Multi-line kommentarer
3. Strengbogstaver
Python ignorerer strenge bogstaver som ikke er tildelt en variabel, så vi kan bruge disse strengliterals som Python-kommentarer .
a) Enkeltlinjekommentarer ved brug af strenge bogstaver
Ved at udføre ovenstående kode kan vi se, at der ikke vil være noget output, så vi bruger strengene med tredobbelte citater () som kommentarer med flere linier.
Python3
'This will be ignored by Python'> |
>
>
b) Kommentarer med flere linier ved hjælp af strenge bogstaver
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
java punkt
>Produktion
Multiline comments>
4. Docstring
- Python docstring er strengen bogstaver med tredobbelte anførselstegn, der vises lige efter funktionen.
- Det bruges til at knytte dokumentation, der er skrevet med Python-moduler, funktioner, klasser og metoder.
- Det er tilføjet lige under funktionerne, modulerne eller klasserne for at beskrive, hvad de gør. I Python gøres docstringen derefter tilgængelig via __doc__-attributten.
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__)> |
>
>
Produktion:
Multiplies the value of a and b>
Fordele ved kommentarer i Python
Kommentarer bruges generelt til følgende formål:
- Kode læsbarhed
- Forklaring af koden eller metadata for projektet
- Forhindre udførelse af kode
- At inkludere ressourcer
Den rigtige måde at skrive kommentarer på
Kommentarer tjener hovedformålet med at forklare din kode. Udviklere bruger sund praksis for at skrive kommentarer for bedre forståelse af koden.
Nogle af de tips, du kan følge for at gøre dine kommentarer effektive, er:
- Kommentarer skal være korte og præcise.
- Brug kun kommentarer, når det er nødvendigt, lad være med at fylde din kode med kommentarer.
- Kommentar skal have en vis betydning.
- Undgå at skrive generiske eller grundlæggende kommentarer.
- Skriv kommentarer, der er selvforklarende.
Vi har diskuteret alt om Python-kommentarer, hvordan man skriver Python-kommentarer, typer af kommentarer, hvad er dets fordele og den rigtige måde at skrive kommentarer på.
Læs også: Hvordan skriver man kommentarer i Python3?