În acest articol, vom aprofunda în conceptul de comentarii pe mai multe linii în Python, oferind o definiție cuprinzătoare împreună cu exemple ilustrative în limbajul de programare Python despre Cum să comentați mai multe linii în Piton .
Ce este un comentariu cu mai multe linii în Python?
Comentariile pe mai multe linii în Python se referă la un bloc de text sau declarații care sunt utilizate în scopuri explicative sau de documentare în cadrul codului. Spre deosebire de comentariile cu o singură linie notate cu simbolul hash (#), comentariile pe mai multe linii sunt închise între ghilimele duble triple (``) sau ghilimele simple triple (`’`). Aceste comentarii sunt adesea folosite pentru a oferi explicații detaliate, documentație sau note despre cod și se pot întinde pe mai multe rânduri. Deși Python nu are o sintaxă specifică pentru comentariile pe mai multe linii, utilizarea ghilimelelor triple obține un efect similar, deoarece interpretul ignoră textul inclus.
Tipuri de comentarii pe mai multe linii în Python
Există două moduri prin care putem adăuga comentarii Python pe mai multe linii în codul nostru. Acestea sunt după cum urmează:
- Comentariu consecutiv pe o singură linie
- Utilizarea unui șir cu mai multe linii ca comentariu
- Folosind metoda Backslash
Comentați mai multe linii în Python folosind Comentariu consecutiv pe o singură linie
În Piton , caracterul hash (#) este folosit pentru a comenta pe linie. O singura linie comentarii în Python nu trebuie să fie doar text pentru a explica codul, ele pot fi, de asemenea, folosite pentru a împiedica Python să execute cod. Caracterul hash ar trebui să fie plasat înaintea fiecărei linii pentru a fi considerat comentarii pe mai multe linii în Python.
Exemplu: Comentariu consecutiv pe o singură linie
Aici, primele două linii conţin un caracter hash (#), iar interpretul împiedică executarea celor două linii. Apoi tipărește Comentariile Python și, în final, va împiedica executarea ultimei linii.
Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')> Ieșire:
Python Comments>
Comentați mai multe linii în Python folosind un șir de mai multe linii ca comentariu
Comentariile Python pe mai multe linii pot fi, de asemenea, incluse într-un delimitator (). Din nou, nu ar trebui să existe spațiu alb între delimitatori (). Ele sunt utile atunci când textul comentariului nu se încadrează într-o singură linie, prin urmare trebuie să se întinde pe rânduri. Acest tip de literal șir este ignorat, deoarece nu este atribuit niciunei variabile. Putem accesa aceste șiruri folosind __doc__.
Exemplu: Utilizarea unui șir cu mai multe linii ca comentariu
Comentariile pe mai multe rânduri sunt folosite pentru a comenta mai multe rânduri. Prima linie este un comentariu pe o singură linie. Al doilea și al treilea rând pot fi comentate folosind ghilimele triple ( ). Acest lucru împiedică executarea codului de mai sus. În cele din urmă, imprimă Matematică în rezultat. Cu toate acestea, dacă aceste comentarii Python pe mai multe linii sunt plasate direct după o funcție sau o semnătură de clasă, atunci acestea se transformă în docstrings .
Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')> Ieșire:
Mathematics>
Comentați mai multe linii în Python folosind metoda Backslash
O metodă de a crea comentarii pe mai multe linii în Python implică utilizarea barei oblice inverse (``) la sfârșitul fiecărei linii pentru a utiliza caracteristica de continuare a liniei, permițând astfel comentariului să se extindă la următoarea linie. Această metodă de continuare a liniei este mai puțin obișnuită decât alte abordări, cum ar fi comentariile consecutive pe o singură linie sau șirurile de mai multe linii și este folosită în primul rând în scopuri de citire a codului atunci când este necesar să spargeți un comentariu pe mai multe linii.
Exemplu : În acest exemplu, comentariile care încep cu#>sunt extinse la mai multe linii folosind bara oblică inversă (>) la sfârșitul fiecărui rând. Bara oblică inversă indică faptul că comentariul continuă pe rândul următor. Această metodă poate fi utilă pentru îmbunătățirea lizibilității codului atunci când aveți comentarii lungi.
# Using backslash for multiline comments # This is a long comment # that spans multiple lines # using the backslash continuation method. # Code continues below print('Hello, World!')> Ieșire:
Hello, World!>
Docstrings în Python
The docstring este o caracteristică încorporată a lui Python, care este utilizată pentru a asocia documentația care a fost scrisă cu modulele, funcțiile, clasele și metodele Python. Este adăugat chiar sub funcții, module sau clase pentru a descrie ceea ce fac. În Python, docstring este apoi disponibil prin intermediul Python __doc__ atribut.
Exemplu: Docstrings în Python
În acest exemplu, după ce funcția multiplică () este definită, am declarat un comentariu docstring folosind ghilimele triple. Apoi tipărim șirul document folosind atributul __doc__.
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>
Diferența dintre comentarii și Docstring în Python
Să vedem diferența dintre comentariile Python și Docstring:
Comentarii | Docstrings |
|---|---|
| Sunt declarate folosind # | Sunt declarate folosind |
| Folosit pentru a crește lizibilitatea codului | Oferă o descriere a modulelor, funcțiilor și claselor Python |
| Ele nu pot fi accesate | Ele pot fi accesate folosind __doc__ |