Uvod u komentare na Pythonu
Bitno je razumjeti tijek programiranja, što se kodira i što služi. Općenito, programer za to koristi komentare kako bi pokazao čemu služi taj kod, koja metoda se koristi za kodiranje / logiku koja stoji iza njega. Ovi komentari neće utjecati na kod, ali pružit će izgled onoga što se radi. Pisanje komentara u kodu pomaže u poboljšanju koda, dok u optimizaciji programer provjerava što treba poboljšati i ako komentari pokažu uporabljenu metodu, to će biti lako optimizirati program. Komentari u Python-u omogućuju i ostalim programerima da znaju i razumiju program. Preporučuje se koristiti dovoljan broj komentara kako kod ne bi bio zbunjujući kad se pogleda unatrag.
Vrste sintakse u Pythonu
U Python-u postoje dvije vrste sintaksa koje se koriste za komentare:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
U svim programskim jezicima određena je sintaksa koja je identificirala što je što. Program je definiran s više sintaksa za npr. Zatvaranje retka u c koristimo zarezom ';', za definiranje započinjanja klase ili petlje koristimo dvotočku ':'. Kao što se vidi, imamo različitu sintaksu koja je dio koda i na nju utječe. Trebao bi postojati sintaksa koja bi mogla reći da komlijer ostavi komentirani dio i prijeđe na sljedeći korak, jer komentari nemaju nikakve veze s rezultatom. Dakle, stvarno je vrlo potrebno razlikovati komentare od stvarnog koda kako se ne bi miješali sa stvarnim programom.
Stvaranje komentara u Pythonu
Programer mora dodati komentar u svoj program kako bi bio razumljiviji. Gdje sada dodati komentare? To je izbor pojedinca, ali evo nekoliko uobičajenih mjesta na kojima dodavanje komentara čini program čitljivijim.
- Početak programa
- Pri definiranju parametara
- Definiranje klase
- Definiranje metoda
- Logika za metode / funkcije
- Opis O postupku
- Da biste provjerili izlaz komada koda
Sljedeće točke su objašnjene u nastavku:
1. Početak programa
Ovdje programer definira što je problem i što je potreba programa.
2. Pri definiranju parametara
Ovdje programer može dodati komentare za svaki parametar u čemu se zalaže, kako će pomoći u programu.
3. Definiranje klase
Program može sadržavati null / jednu ili više klasa, tako da je ključno definirati svrhu klase na početku komentara. Ponekad se savjetuje dodavanje komentara između klase radi definiranja zadatka svakog retka u klasi.
4. Definiranje metoda
Metode su funkcije koje stvaraju odnose između parametara i logike za upravljanje njima. Preporučuje se definirati posao metode u komentarima.
5. Logika za metode / funkcije
Općenito, metoda može imati priložene brojne logike, a komentiranje opisa svake logike može pomoći u razumijevanju postojeće logike i prema potrebi može se mijenjati prema zahtjevu.
6. Opis postupka
Programer za svaki program slijedi postupak korak po korak, a definiranje koraka postupka / Arhitektura koda u komentarima mogla bi pomoći poboljšanju njegove čitljivosti.
7. Da biste provjerili izlaz komada koda
U velikom broju slučajeva programer bi trebao izvršiti promjene u postojećem programu. Ako program ima brojne logike i za provjeru rade li svi u redu ili ne, trebao bi imati referentni izlaz / Očekivani izlaz. Komentiranje rezultata te logike tek nakon što bi logika mogla uštedjeti puno vremena.
Primjeri komentara u Pythonu
Primjeri su dati u nastavku:
Komentari nemaju učinka na izlaz nikada, ali oni čine program čitljivijim. Evo nekoliko primjera komentara pythona.
1. Komentiranje jednog retka odjednom: Ovdje radimo dodavanje na dvije varijable.
# 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
Izlaz: 22
2. Komentiranje više redaka odjednom: Ponekad je potrebno dati opis neke logike za koji je potrebno komentirati više redaka odjednom. Komentiranje jednog retka, iznova i iznova, mogao bi biti naporan posao, pa za to koristimo trostruke navodnike.
"""
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)
Izlaz: 22
3. Komentiranje jednog retka kao i više redaka istovremeno: programer u većini slučajeva koristi obje vrste komentara kako bi napravio program više čitljiv.
"""
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
Izlaz: 22
Ovdje smo vidjeli nekoliko slučajeva komentara, koji se koriste u programu. U slučaju strojnog učenja postoje različite vrste modela koji se koriste za predviđanje rezultata. Treba modelirati parametre, hiperparametre i postupak koji se koristi u algoritmu. Komentiranje različitih pristupa za model s različitim parametrima može uštedjeti ponovljivost i može uštedjeti vrijeme.
Zaključak - Komentari na Pythonu
Komentari u programu vrlo su korisni za njihovo razumijevanje. U pythonu u osnovi imamo dvije vrste komentara kako bismo komentirali jedan redak sintaksom (#) ili komentirali više redaka, a koristimo trostruke navodnike („). Komentari nisu tamo kako bi utjecali na kod, nego samo radi dodavanja opisa onoga što se tamo kodira, a komentari ne bi bili dio rezultata.
Preporučeni članci
Ovo je vodič za komentare na Pythonu. Ovdje smo raspravljali o Uvodu, Stvaranju komentara na Pythonu, uzeli smo u obzir, primjere i sintaksu itd. Također možete proći kroz naše druge predložene članke da biste saznali više -
- Zamjena u Pythonu
- Naredbe Python
- Obrnuti inženjering s Pythonom
- Zamjena u C
- Varijable u JavaScript-u
- Obrnuti inženjering | Koristi | Etički problemi
- Kako komentari djeluju u PHP-u? | Primjeri