Kommentarer i Python är raderna i koden som ignoreras av tolken under körningen av programmet.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Kommentarer förbättrar kodens läsbarhet och hjälper programmerarna att förstå koden mycket noggrant. Det hjälper också till att samarbeta med andra utvecklare eftersom att lägga till kommentarer gör det lättare att förklara koden.
Typer av kommentarer i Python
Det finns tre typer av kommentarer i Python:
- En rad kommentarer
- Flerlinjekommentarer
- Strängbokstavar
- Docstring-kommentarer
Kommentarer i Python
I exemplet kan det ses att Pytonorm Kommentarer ignoreras av tolken under körningen av programmet.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Produktion:
geeksforgeeks>
Varför används kommentarer i Python?
Kommentarer har varit en integrerad del av programmeringsspråk, och varje språk har olika sätt att använda kommentarer.
Precis som alla andra språk tjänar kommentarer i Python följande syfte:
- Förbättra kodläsbarheten
- Förklara kod för andra
- Förstå kod om den studeras efter en tid
- Dokumentera steg och behov för en funktion
- Dela kod med andra utvecklare
- Samarbetar med flera personer.
Typer av kommentarer i Python
Låt oss upptäcka de olika typerna av kommentarer, hur man använder dem och när man ska använda dem?
1. Enkellinje Kommentarer
- Python enradskommentar börjar med hashtag-symbolen (#) utan blanksteg och varar till slutet av raden.
- Om kommentaren överstiger en rad, sätt en hashtag på nästa rad och fortsätt med Python-kommentaren.
- Pythons enkelradskommentarer har visat sig vara användbara för att tillhandahålla korta förklaringar för variabler, funktionsdeklarationer och uttryck. Se följande kodavsnitt som visar en rad kommentar:
Exempel:
Python3
round robin schemaläggning
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
sträng till array java
>Produktion
techcodeview.com>
2. Flerlinjekommentarer
Python ger inte alternativet för flerradiga kommentarer . Det finns dock olika sätt genom vilka vi kan skriva flerradiga kommentarer.
a) Flerradskommentarer med flera hashtags (#)
Vi kan flera hashtags (#) för att skriva flerradskommentarer i Python. Varje rad kommer att betraktas som en enradskommentar.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Produktion
Multiline comments>
Kolla också: Intressant fakta om Python Multi-line Kommentarer
3. Strängbokstavar
Python ignorerar sträng bokstaver som inte är tilldelade en variabel så vi kan använda dessa strängliteraler som Python-kommentarer .
a) Enradskommentarer med strängliteraler
När vi kör ovanstående kod kan vi se att det inte kommer att finnas någon utdata så vi använder strängarna med tredubbla citat () som flerradskommentarer.
Python3
'This will be ignored by Python'> |
>
>
b) Flerradskommentarer med strängliteraler
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Produktion
Multiline comments>
4. Docstring
- Python docstring är bokstavssträngen med trippelcitattecken som visas direkt efter funktionen.
- Den används för att associera dokumentation som har skrivits med Python-moduler, funktioner, klasser och metoder.
- Den läggs till precis under funktionerna, modulerna eller klasserna för att beskriva vad de gör. I Python görs docstringen sedan tillgänglig via attributet __doc__.
Exempel:
Python3
binärt träd i java
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>
Fördelar med kommentarer i Python
Kommentarer används vanligtvis för följande syften:
- Kodläsbarhet
- Förklaring av koden eller metadata för projektet
- Förhindra exekvering av kod
- Att inkludera resurser
Rätt sätt att skriva kommentarer
Kommentarer tjänar det huvudsakliga syftet att förklara din kod. Utvecklare använder sund kommentarsskrivning för att bättre förstå koden.
Några av de tips du kan följa för att göra dina kommentarer effektiva är:
- Kommentarer bör vara korta och exakta.
- Använd endast kommentarer när det är nödvändigt, belamra inte din kod med kommentarer.
- Kommentar bör ha någon betydelse.
- Undvik att skriva allmänna eller grundläggande kommentarer.
- Skriv kommentarer som är självförklarande.
Vi har diskuterat allt om Python-kommentarer, hur man skriver Python-kommentarer, typer av kommentarer, vad är det för fördelar och det rätta sättet att skriva kommentarer.
Läs också: Hur skriver man kommentarer i Python3?