Kommentarer i Python - Oprettelse af kommentarer i Python

Indholdsfortegnelse:

Anonim

Introduktion til kommentarer i Python

Det er vigtigt at forstå strømningen af ​​programmering, hvad man koder og hvad for. For at gøre dette bruger en programmør generelt kommentarer til at vise, hvad der er det stykke kode til, hvilken metode der bruges til kodning / logikken bag det. Disse kommentarer vil ikke have indflydelse på koden, men det giver et layout til, hvad der gøres. Skrivning af kommentarer i kode hjælper med at forbedre koden, da en programmerer ved optimering kontrollerer, hvad der skulle forbedres, og hvis kommentarer viser den anvendte metode, vil det være let at optimere programmet. Kommentarer i Python lader også de andre udviklere kende og forstå programmet. Det anbefales at bruge et tilstrækkeligt antal kommentarer, så koden ikke ville være forvirrende, når den så tilbage.

Typer af syntaks i Python

I Python er der to typer syntakser, der bruges til kommentarer:

#: Is used to comment on one line.

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

På alle programmeringssprog er der defineret nogle syntaks for at identificere, hvad der er hvad. Et program er defineret med et antal syntakser til f.eks. Lukning af en linje i c bruger vi en semikolon ';', For at definere start af en klasse eller sløjfe bruger vi kolon ':'. Som det kan ses, har vi en anden syntaks, som er en del af koden og påvirker den. Der skal være en vis syntaks, der kan sige kompilator for at forlade kommenteret del og gå til næste trin, da kommentarer ikke har noget at gøre med output. Så det er virkelig meget nødvendigt at skelne kommentarerne fra den faktiske kode, så de ikke skal forveksles med det faktiske program.

Oprettelse af kommentarer i Python

En programmerer skal tilføje en kommentar i sit program for at gøre det mere forståeligt. Hvor skal man nu tilføje kommentarer? Det er individets valg, men her er nogle almindelige steder, hvor tilføjelse af kommentarer gør et program mere læseligt.

  1. Start af programmet
  2. Ved definition af parametre
  3. Definition af en klasse
  4. Definition af metoder
  5. Logik for metoder / funktioner
  6. Beskrivelse Om proceduren
  7. For at krydstjekke output af et stykke kode

Følgende punkter er blevet forklaret nedenfor:

1. Start af programmet

Her definerer en programmør, hvad der er problemopgørelsen, og hvad er programmets behov.

2. Ved definition af parametre

Her kan en programmør tilføje kommentarer til hver parameter, hvad den står for, hvordan det vil hjælpe i programmet.

3. Definition af en klasse

Et program kan indeholde null / en eller flere klasser, så det er vigtigt at definere formålet med klassen i begyndelsen af ​​kommentarerne. Undertiden anbefales det at tilføje kommentarer mellem klassen for at definere jobbet for hver linje i klassen.

4. Definition af metoder

Metoder er funktioner, der skaber relationer mellem parametre og logik til at manipulere det. Det anbefales at definere metodens job i kommentarer.

5. Logikken for metoderne / funktionerne

Generelt kan en metode have et antal logikker knyttet til den, kommenterende beskrivelse af hver logik kan hjælpe med at forstå eksisterende logik, og om nødvendigt kan ændres i henhold til kravet.

6. Beskrivelse af proceduren

For hvert program følger en programmerer en trin for trin-procedure, og definition af proceduretrin / Arkitektur af koden i kommentarer kan hjælpe med at forbedre dens læsbarhed.

7. For at krydskontrol af output fra et stykke kode

I en række tilfælde er en programmerer nødt til at foretage ændringer i det eksisterende program. Hvis et program har et antal logikker og for at krydstjekke, om alle fungerer fint eller ej, skal han have referenceoutput / forventet output. At kommentere output fra denne logik lige efter logik kan spare en masse tid.

Eksempler på kommentarer i Python

Eksemplerne er givet nedenfor:

Kommentarer har ingen indflydelse på output, hvad det nogensinde er, men de gør et program mere læsbart. Her er nogle eksempler på kommentarer i python.

1. Kommentere en linje ad gangen: Her udfører vi additionsoperation 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

Output: 22

2. Kommentering af flere linjer ad gangen: Nogle gange er det påkrævet at give en beskrivelse af en vis logik, som der er behov for at kommentere flere linjer ad gangen. At kommentere en enkelt linje igen og igen kan være et trættende job, så vi bruger tredobbelt citater til 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)

Output: 22

3. Kommentere en linje såvel som flere linjer på samme tid: I de fleste tilfælde bruger en programmør begge typer kommentarer for at gøre programmet mere læsbart.

"""
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

Output: 22

Her har vi set nogle tilfælde af kommentarer, der bruges i et program. I tilfælde af maskinlæring er der forskellige typer modeller, der bruges til at forudsige output. Et behov for at modellere parametre, hyperparametre og procedure, der bruges i algoritmen. At kommentere forskellige tilgange til modellen med forskellige parametre kan spare gentagelighed og kan spare tid.

Konklusion - Kommentarer i Python

Kommentarer i et program er meget nyttige til at forstå dem. I python har vi dybest set to typer kommentarer, enten til at kommentere en linje med (#) syntaks eller for at kommentere flere linjer, vi bruger tredobbelt citater (“). Kommentarer er ikke der for at påvirke koden, men bare for at tilføje en beskrivelse af, hvad der kodes der, og kommentarer ville ikke være en del af output.

Anbefalede artikler

Dette er en guide til kommentarer i Python. Her diskuterer vi introduktionen, oprettelse af kommentarer i Python har taget hensyn til, eksempler og syntaks osv. Du kan også gennemgå vores andre foreslåede artikler for at lære mere -

  1. Udskiftning i Python
  2. Python-kommandoer
  3. Omvendt engineering med Python
  4. Udskiftning i C
  5. Variabler i JavaScript
  6. Reverse Engineering | Anvendelser | Etiske problemer
  7. Hvordan fungerer kommentarer i PHP? | eksempler