Komentari u programiranju su najkorisniji tekstualni dijelovi koji pružaju kratke informacije o određenom kodu. Možete koristiti komentare u svom kodu kao pomoć s dokumentacijom. To će nekoga informirati o onome što ste napisali. Koncept komentara u programiranju može pomoći dinamičnim radnim timovima da razumiju koji su kod napisali prethodni timovi i još mnogo toga. Sada smo ovdje da razgovaramo o komentarima u pythonu i zajedno s ovim možemo pričati sve o komentarima. Idemo!!!
Zašto biste trebali koristiti komentare tijekom kodiranja?
Komentare možete koristiti u razne svrhe. Održava vaš kod čistim, čitljivim i dobro dokumentiranim. Naveo sam neke primjene komentara u kodiranju.
- Za planiranje i pregled vašeg koda:
Da, kao što ime sugerira, možete napisati pseudokod koristeći komentare prije pisanja izvornog koda. Ovo planiranje ne samo da će pomoći u dokumentiranju, već će i vaš izvorni kod postati puno lakši za čitanje.
- Opis vašeg koda:
Tijekom kodiranja možete koristiti komentare da biste napisali opis rada koda ili što možete očekivati od određene linije koda. Primjere možemo vidjeti u kasnijim fazama članka.
Tijekom kodiranja možete umetnuti ASCII znak, logotipe i dijagrame toka za bolje razumijevanje ili bilo koju posebnu svrhu. No, najbolje je što ih možete oblikovati kao komentare.
U procesu kodiranja, naredbe za ispis koriste se u redovitim intervalima za ispis vrijednosti za prepoznavanje grešaka koje se pojavljuju. Kasnije, korištenjem komentara, možete negirati te ispisne izjave.
U kodiranju će najveći stres biti pronalaženje grešaka i nemogućnost razumijevanja kodova koje je netko prethodno napisao. Programeri provode većinu vremena u ovoj fazi. Ali upotreba komentara za opisivanje, dokumentiranje i otklanjanje pogrešaka koda također može olakšati i ubrzati rad.
Kako komentirati python kod?
Svaki jezik ima komentiranje opcija za poboljšanje kvalitete koda, čitljivosti i svrhe dokumentacije. Python ovdje nije iznimka. Možete ostavljati komentare u pythonu. Prije nego što to učinimo, trebali biste znati o različitim vrstama komentara u pythonu. Dakle, raspravimo svaki od njih s primjerima.
Jednoredni komentari u pythonu
Osnovna značajka komentara u jednom retku u pythonu je da započinju s “#” (Hashtag) bez razmaka ili razmaka. Note da kada komentar prelazi jedan redak, morate koristiti drugi hashtag u novom retku. Možete koristiti komentare u jednom retku posebno za kratke opise, kratke bilješke, deklaracije funkcija i još mnogo toga.
#This is my first python comment
#Print "Hackanons" in the output
print("Hackanons")
Hackanons
Kao što vidite, možete koristiti komentare u jednom retku da napravite kratke opise, a također možete napisati što će određena linija koda raditi.
Višeredni komentari u pythonu
Višeredni komentari u pythonu mogu se vidjeti kao tekst koji se nalazi između skupa graničnika – (” ” “). U komentarima u jednom retku upotrijebit ćete # prije teksta. Ali ovdje svoj tekst morate staviti između nekoliko graničnika kao što je prikazano. Trebali biste ostaviti razmak između graničnika. Višeredni komentari doći će u skupinu kada jednoredni komentari nisu dovoljni da prenesu značenje.
"""
This is my first python multiline comment.
I just saw an article which explains the comments in python.
There I learnt how to use multiline comments in python.
Now I am printing, what I have learnt today.
"""
print("Today, I learnt about multiline comments in python")
Today, I learnt about multiline comments in python
Ovu vrstu komentara možete koristiti za detaljan opis. Možete dodati onoliko redaka koliko želite.
Python Docstring komentari
Docstring komentari jedni su od najkorisnijih vrste komentara u pythonu. Ovaj komentar treba dodati ispod funkcije, klase ili metode. Kasnije ga možete pozvati pomoću atributa _doc_ u izjavi za ispis. Pogledajmo kako radi.
def add(a,b):
"""Adds a with b"""
return a+b
print(add.__doc__)
Adds a with b
Vau!. Možete vidjeti kako nevjerojatna ugrađena vrsta komentara radi za vas.
Spojimo sve zajedno!!!
Do sada smo u pythonu naišli na tri vrste komentara. Pod pretpostavkom da nemate sumnje u sve to, idem malo naprijed i koristim sva tri komentara u jednom kodu. Tako ćete dobiti jasnu sliku rada komentara koda.
"""
Over the past 10 minutes, we have learn about comments in python.
We have gone through 3 types of comments and thier usage.
Now, it's time to put it altogether.
Let's roll!!!
"""
def substract(a,b):
"""Substrcts value of a with value of b"""
return a-b
#Print the docstring comment output
print(substract.__doc__)
Substracts value of a with value of b
Završavati
Komentari jedan su od najkorisnijih aspekata programiranja. Python podržava 3 vrste komentara. Jednoredni, višeredni i komentari niza dokumenata. Sve smo prošli 3 vrste komentara s ilustracijama. Komentari u pythonu također dodaju više vrijednosti kvaliteti koda, dokumentaciji, otklanjanju pogrešaka i čitljivosti. Toliko za sada, drugi put neka druga tema. Sretan piton!!!
