Uvod v komentarje v Pythonu
Pomembno je razumeti tok programiranja, kaj se kodira in za kaj. Na splošno programer uporablja komentarje, da pokaže, za kaj gre v tem kodu, za katero metodo se uporablja kodiranje / logiko, ki stoji za njim. Ti komentarji ne bodo vplivali na kodo, vendar bodo zagotovili postavitev tega, kar se počne. Pisanje komentarjev v kodi pomaga izboljšati kodo, saj programer pri optimizaciji preveri, kaj je treba izboljšati, in če komentarji pokažejo uporabljeno metodo, bo program enostavno optimizirati. Pripombe v Python-u sporočajo tudi drugim razvijalcem in razumejo program. Priporočljivo je, da uporabite zadostno število komentarjev, tako da koda ne bi bila zmedena, če pogledate nazaj.
Vrste sintakse v Pythonu
V Python-u sta za komentarje uporabljeni dve vrsti sintaksov:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
V vseh programskih jezikih je bila določena sintaksa, ki opredeljuje, kaj je kaj. Program je določen s številnimi skladnjami, na primer za zapiranje vrstice v c uporabimo podpičje ';', za definiranje začetka razreda ali zanke uporabimo dvopičje ':'. Kot je razvidno, imamo drugačno skladnjo, ki je del kode in vpliva nanjo. Morala bi obstajati sintaksa, ki bi lahko rekla, da bi komentirali, da zapusti komentirani del in nadaljuje na naslednji korak, saj komentarji nimajo nobene zveze z izhodom. Torej je resnično treba razlikovati pripombe od dejanske kode, da je ne bi zamenjali z dejanskim programom.
Ustvarjanje komentarjev v Pythonu
Programer mora v svoj program dodati komentar, da bo bolj razumljiv. Kje zdaj dodati komentarje? Izbira posameznika, vendar je tukaj nekaj skupnih mest, kjer dodajanje komentarjev program naredi bolj berljiv.
- Začetek programa
- Pri določanju parametrov
- Določitev razreda
- Določanje metod
- Logika za metode / funkcije
- Opis O postopku
- Za navzkrižno preverjanje rezultata kode
Spodaj so pojasnjene naslednje točke:
1. Začetek programa
Tu programer opredeli, kaj je težava in kaj je treba v programu.
2. Pri določanju parametrov
Tu lahko programer za vsak parameter doda komentarje, za kaj stoji, kako bo pomagal v programu.
3. Določitev razreda
Program lahko vsebuje ničelne / enega ali več razredov, zato je nujno, da na začetku komentarjev določite namen razreda. Včasih je priporočljivo, da v razred dodate komentarje, da določite opravilo vsake vrstice v razredu.
4. Določanje metod
Metode so funkcije, ki ustvarjajo razmerja med parametri in logiko za upravljanje z njimi. Priporočljivo je, da v komentarjih določite delo metode.
5. Logika metod / funkcij
Na splošno ima metoda lahko nanjo priložene številne logike, komentiranje opisa vsake logike lahko pomaga razumeti obstoječo logiko in po potrebi se lahko spremeni glede na zahtevo.
6. Opis postopka
Programer za vsak program sledi postopnemu postopku in določitev korakov postopka / Arhitektura kode v komentarjih bi lahko pripomogla k boljši berljivosti.
7. Če želite preveriti izhod dela kode
V številnih primerih bi moral programer spremeniti obstoječi program. Če ima program številne logike in če želite preveriti, ali vsi delujejo v redu ali ne, bi moral imeti referenčni izhod / Pričakovani izhod. Komentiranje rezultatov te logike bi tik po logiki lahko prihranilo veliko časa.
Primeri komentarjev v Pythonu
Primeri so navedeni spodaj:
Komentarji nimajo nobenega vpliva na izid, vendar program naredijo bolj berljiv. Tu je nekaj primerov komentarjev pythona.
1. Komentiranje ene vrstice naenkrat: Tu izvajamo operacijo dodajanja dveh spremenljivk.
# 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
Izhod: 22
2. Komentiranje več vrstic hkrati: Včasih je treba opisati nekaj logike, za katero je treba komentirati več vrstic hkrati. Komentiranje posamezne vrstice bi lahko bilo vedno naporno delo, zato za to uporabljamo trojne navedke.
"""
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)
Izhod: 22
3. Komentiranje ene vrstice in več vrstic hkrati: Programer v večini primerov uporablja obe vrsti komentarjev, da bi naredil program bolj berljiv.
"""
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
Izhod: 22
Tu smo videli nekaj primerov komentarjev, ki se uporabljajo v programu. V primeru strojnega učenja obstajajo različni modeli, ki se uporabljajo za napovedovanje rezultatov. Treba je modelirati parametre, hiperparametre in postopek, uporabljen v algoritmu. Komentiranje različnih pristopov za model z različnimi parametri lahko prihrani ponovljivost in prihrani čas.
Zaključek - komentarji v Pythonu
Komentarji v programu so zelo koristni pri njihovem razumevanju. V pythonu imamo v osnovi dve vrsti komentarjev, bodisi da komentiramo eno vrstico s sintakso (#) bodisi da komentiramo več vrstic, uporabimo trojne narekovaje (“). Komentarji niso tam, da bi vplivali na kodo, ampak samo zato, da bi dodali opis tega, kaj se tam šifrira, in komentarji ne bi bili del izhoda.
Priporočeni članki
To je vodnik za komentarje v Pythonu. Tu smo razpravljali o uvodu, ustvarjanju komentarjev v Pythonu, upoštevali smo primere in sintakso itd. Če želite izvedeti več, lahko preberete tudi druge predloge, ki jih predlagate -
- Zamenjava Pythona
- Ukazi Python
- Reverse Engineering s Python-om
- Zamenjava v C
- Spremenljivke v JavaScript
- Povratni inženiring | Uporaba | Etična vprašanja
- Kako komentarji delujejo v PHP-ju? | Primeri