Comentarii în Python sunt liniile din cod care sunt ignorate de interpret în timpul execuției programului.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Comentariile sporesc lizibilitatea codului și ajută programatorii să înțeleagă codul cu mare atenție. De asemenea, ajută la colaborarea cu alți dezvoltatori, deoarece adăugarea de comentarii facilitează explicarea codului.
Tipuri de comentarii în Python
Există trei tipuri de comentarii în Python:
- Comentarii pe un singur rând
- Comentarii pe mai multe linii
- Literale șiruri
- Comentarii Docstring
Comentarii în Python
În exemplu, se poate observa că Piton Comentariile sunt ignorate de interpret în timpul execuției programului.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Ieșire:
geeksforgeeks>
De ce sunt folosite comentariile în Python?
Comentariile au fost o parte integrantă a limbajelor de programare și fiecare limbă are moduri diferite de a folosi comentariile.
La fel ca orice altă limbă, comentariile în Python servesc următorului scop:
- Îmbunătățiți lizibilitatea codului
- Explicarea codului altora
- Înțelegerea codului dacă este studiat după ceva timp
- Documentarea pașilor și nevoilor unei funcții
- Partajarea codului cu colegii dezvoltatori
- Colaborarea cu mai multe persoane.
Tipuri de comentarii în Python
Să descoperim diferitele tipuri de comentarii, cum să le folosim și când să le folosim?
1. Single-Line Comentarii
- Comentariul Python pe o singură linie începe cu simbolul hashtag (#) fără spații albe și durează până la sfârșitul rândului.
- Dacă comentariul depășește o linie, puneți un hashtag pe linia următoare și continuați Comentariul Python.
- Comentariile pe o singură linie ale lui Python s-au dovedit utile pentru furnizarea de explicații scurte pentru variabile, declarații de funcție și expresii. Vedeți următorul fragment de cod care demonstrează comentariul pe o singură linie:
Exemplu:
Python3
np.log
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Ieșire
techcodeview.com>
2. Comentarii pe mai multe rânduri
Python nu oferă opțiunea pentru comentarii pe mai multe linii . Cu toate acestea, există diferite moduri prin care putem scrie comentarii pe mai multe linii.
a) Comentarii pe mai multe rânduri folosind mai multe hashtag-uri (#)
Putem mai multe hashtag-uri (#) pentru a scrie comentarii pe mai multe linii în Python. Fiecare rând va fi considerat un comentariu pe o singură linie.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
beneficiile instagramului pentru uz personal
>Ieșire
Multiline comments>
Verificați și: Fapt interesant despre comentariile cu mai multe linii Python
3. Literale șiruri
Python ignoră literale șir care nu sunt alocate unei variabile, astfel încât să putem folosi aceste literale șir ca Comentarii Python .
a) Comentarii pe o singură linie folosind literali șir
La executarea codului de mai sus putem vedea că nu va exista nicio ieșire, așa că folosim șirurile cu ghilimele triple () ca comentarii pe mai multe rânduri.
Python3
'This will be ignored by Python'> |
numărați sql distinct
>
>
b) Comentarii pe mai multe linii folosind literali șir
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Ieșire
Multiline comments>
4. Docstring
- Docstring Python este literalele șir cu ghilimele triple care apar imediat după funcție.
- Este folosit pentru a asocia documentația care a fost scrisă cu module, funcții, clase și metode Python.
- Este adăugat chiar sub funcții, module sau clase pentru a descrie ceea ce fac. În Python, docstring este apoi disponibil prin atributul __doc__.
Exemplu:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Ieșire:
Multiplies the value of a and b>
Avantajele comentariilor în Python
Comentariile sunt utilizate în general în următoarele scopuri:
- Lizibilitatea codului
- Explicația codului sau a metadatelor proiectului
- Preveniți executarea codului
- Să includă resurse
Modul corect de a scrie comentarii
Comentariile au scopul principal de a explica codul dvs. Dezvoltatorii folosesc o practică sănătoasă de scriere a comentariilor pentru o mai bună înțelegere a codului.
Unele dintre sfaturile pe care le puteți urma pentru a face comentariile dvs. eficiente sunt:
- Comentariile trebuie să fie scurte și precise.
- Folosiți comentarii numai atunci când este necesar, nu vă aglomerați codul cu comentarii.
- Comentariul ar trebui să aibă un anumit sens.
- Evitați să scrieți comentarii generice sau de bază.
- Scrieți comentarii care se explică de la sine.
Am discutat totul despre comentariile Python, cum să scrieți comentarii Python, tipurile de comentarii, care sunt avantajele sale și modul corect de a scrie comentarii.
Citește și: Cum se scriu comentarii în Python3?