Kommentarer i Python - Opprette kommentarer i Python

Innholdsfortegnelse:

Anonim

Introduksjon til kommentarer i Python

Det er viktig å forstå flyten av programmering, hva man koder og hva for. For å gjøre dette bruker en programmerer generelt kommentarer for å vise hva som er det kodestykket, hvilken metode som brukes for koding / logikken bak. Disse kommentarene kommer ikke til å påvirke koden, men det vil gi en layout for hva som blir gjort. Å skrive kommentarer i kode hjelper til med å forbedre koden som ved optimalisering en programmerer sjekker hva som måtte forbedres, og hvis kommentarer viser metoden som brukes, vil det være enkelt å optimalisere programmet. Kommentarer i Python lar også de andre utviklerne vite og forstå programmet. Det anbefales å bruke et tilstrekkelig antall kommentarer slik at koden ikke ville være forvirrende når den så tilbake.

Typer syntaks i Python

I Python er det to typer syntakser som brukes til kommentarer:

#: Is used to comment on one line.

Triple quotes (“): To comment more than one line.

På alle programmeringsspråk er det definert noen syntaks for å identifisere hva som er hva. Et program er definert med et antall syntakser for å for eksempel stenge en linje i c bruker vi et semikolon ';', For å definere start av en klasse eller sløyfe bruker vi kolon ':'. Som det fremgår har vi en annen syntaks som er delen av koden og påvirker den. Det bør være noen syntaks som kan si kompliser for å legge igjen kommentert del og gå til neste trinn, da kommentarer ikke har noe med utdata å gjøre. Så det er virkelig veldig nødvendig å skille kommentarene fra den faktiske koden, slik at den ikke skal forveksles med selve programmet.

Opprette kommentarer i Python

En programmerer må legge til en kommentar i programmet sitt for å gjøre det mer forståelig. Hvor skal du legge til kommentarer? Det er individets valg, men her er noen vanlige steder der det å legge til kommentarer gjør et program mer leselig.

  1. Start av programmet
  2. Ved definering av parametere
  3. Definere en klasse
  4. Definere metoder
  5. Logikk for metodene / funksjonene
  6. Beskrivelse Om prosedyren
  7. For å krysse av utdata fra et kodestykke

Følgende punkter er blitt forklart nedenfor:

1. Start av programmet

Her definerer en programmerer hva som er problemstillingen og hva er behovet for programmet.

2. Når du definerer parametere

Her kan en programmerer legge til kommentarer for hver parameter hva den står for, hvordan det vil hjelpe i programmet.

3. Definere en klasse

Et program kan inneholde null / en eller flere klasser, så det er viktig å definere formålet med klassen i begynnelsen av kommentarene. Noen ganger anbefales det å legge til kommentarer mellom klassen for å definere jobben til hver linje i klassen.

4. Definere metoder

Metoder er funksjoner som skaper relasjoner mellom parametere og logikk for å manipulere den. Det anbefales å definere metodens jobb i kommentarer.

5. Logikken for metodene / funksjonene

Generelt sett kan en metode ha et antall logikker knyttet til seg, kommenterende beskrivelse av hver logikk kan bidra til å forstå eksisterende logikk, og om nødvendig kan endres i henhold til kravet.

6. Beskrivelse av prosedyren

For hvert program følger en programmerer en trinnvis prosedyre og å definere prosedyretrinnene / Arkitektur av koden i kommentarer kan bidra til å forbedre dens lesbarhet.

7. For å krysse av utdataene fra et kodestykke

I flere tilfeller vil en programmerer måtte gjøre endringer i det eksisterende programmet. Hvis et program har et antall logikker og for å krysse av om alle fungerer bra eller ikke, bør han ha referanseutgang / forventet utgang. Å kommentere resultatene fra den logikken rett etter logikken, kan spare mye tid.

Eksempler på kommentarer i Python

Eksemplene er gitt nedenfor:

Kommentarer har ingen innvirkning på output noensinne, men de gjør et program mer leselig. Her er noen eksempler på kommentarer i python.

1. Kommentere en linje om gangen: Her utfører vi tilleggsoperasjon på to variabler.

# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output

Utgang: 22

2. Kommentere flere linjer om gangen: Noen ganger er det nødvendig å gi en beskrivelse av en eller annen logikk, som det er behov for å kommentere flere linjer om gangen. Å kommentere en enkelt linje igjen og igjen kan være en slitsom jobb, så vi bruker trippel sitater for dette.

"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)

Utgang: 22

3. Kommentere én linje og flere linjer samtidig: I de fleste tilfeller bruker en programmerer begge typer kommentarer for å gjøre programmet mer lesbart.

"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output

Utgang: 22

Her har vi sett noen tilfeller av kommentarer, som brukes i et program. Når det gjelder maskinlæring, er det forskjellige typer modeller som brukes til å forutsi utgangen. Et behov for å modellere parametere, hyperparametre og prosedyre som brukes i algoritmen. Å kommentere forskjellige tilnærminger for modellen med forskjellige parametere kan spare repeterbarhet og kan spare tid.

Konklusjon - Kommentarer i Python

Kommentarer i et program er veldig nyttige for å forstå dem. I python har vi i utgangspunktet to typer kommentarer enten for å kommentere en linje med (#) syntaks eller for å kommentere flere linjer vi bruker trippel sitater (“). Kommentarer er ikke der for å påvirke koden, men bare for å legge til en beskrivelse av hva som blir kodet der, og kommentarer vil ikke være en del av utdataene.

Anbefalte artikler

Dette er en guide til Kommentarer i Python. Her diskuterer vi introduksjonen, lage kommentarer i Python har tatt i betraktning, eksempler og syntaks, osv. Du kan også gå gjennom våre andre foreslåtte artikler for å lære mer -

  1. Bytting av Python
  2. Python-kommandoer
  3. Omvendt engineering med Python
  4. Bytt i C
  5. Variabler i JavaScript
  6. Omvendt ingeniør | Bruker | Etiske problemstillinger
  7. Hvordan fungerer kommentarer i PHP? | eksempler