În acest tutorial, vom învăța să creăm comentarii în Python cu ajutorul unor exemple.
Video: comentarii în Python
Comentariile sunt descrieri care îi ajută pe programatori să înțeleagă mai bine intenția și funcționalitatea programului.
Acestea sunt complet ignorate de interpretul Python.
Avantajele utilizării comentariilor
Utilizarea comentariilor în programe face ca codul nostru să fie mai ușor de înțeles. Acesta face programul mai lizibil, ceea ce ne ajută să ne amintim de ce au fost scrise anumite blocuri de cod.
În afară de asta, comentariile pot fi folosite și pentru a ignora un anumit cod în timp ce testează alte blocuri de cod. Aceasta oferă o modalitate simplă de a preveni executarea unor linii sau de a scrie un pseudo-cod rapid pentru program.
Comentarii cu o singură linie în Python
În Python, folosim simbolul hash #pentru a scrie un comentariu pe o singură linie.
Exemplul 1: Scrierea comentariilor pe o singură linie
# printing a string print('Hello world')
Ieșire
Salut Lume
Aici, comentariul este:
# printing a string
Această linie este ignorată de interpretul Python.
Tot ce vine după #este ignorat. Deci, putem scrie și programul de mai sus într-o singură linie ca:
print('Hello world') #printing a string
Rezultatul acestui program va fi același ca în Exemplul 1 . Interpretul ignoră tot textul după #.
Comentarii multi-linie în Python
Python nu oferă o modalitate separată de a scrie comentarii pe mai multe linii. Cu toate acestea, există și alte modalități de a rezolva această problemă.
Putem folosi #la începutul fiecărei linii de comentariu pe mai multe linii.
Exemplul 2: utilizarea mai multor #
# it is a # multiline # comment
Aici, fiecare linie este tratată ca un singur comentariu și toate sunt ignorate.
Litere șir pentru comentarii pe mai multe linii
Chiar dacă nu există o modalitate unică de a scrie comentarii pe mai multe linii în Python, știm că interpretul Python ignoră literele șirului care nu sunt atribuite unei variabile.
Deci, putem scrie chiar un comentariu pe o singură linie ca:
#this is a comment 'this is an unassigned string as a comment '
Aici, putem vedea că a doua linie a programului este un șir, dar nu este atribuită niciunei variabile sau funcții. Deci, interpretul ignoră șirul.
Într-un mod similar, putem folosi șiruri multiliniu (ghilimele triple) pentru a scrie comentarii multiliniu.
Caracterul citat poate fi 'sau ".
Exemplul 3: Utilizarea literelor șir pentru a scrie comentarii pe mai multe linii
''' I am a multiline comment! ''' print("Hello World")
Aici, șirul multiliniu nu este atribuit niciunei variabile, deci este ignorat de interpret. Chiar dacă nu este un comentariu din punct de vedere tehnic, poate fi folosit ca unul.
Șiruri de documente Python
Prin convenție, ghilimelele triple care apar imediat după funcția, metoda sau definiția clasei sunt docstrings (șiruri de documentare).
Docstring-urile sunt asociate cu obiecte și pot fi accesate folosind __doc__atributul.
Pentru a afla mai multe, accesați Python docstrings.
Cum să scrieți comentarii mai bune?
- Folosiți comentarii pentru a descrie ce face o funcție și nu detaliile specifice despre cum o face funcția.
- Încercați să eliminați cât mai multe comentarii redundante posibil. Încercați să scrieți cod care se poate explica, folosind o funcție mai bună / alegerea numelui variabilei.
- Încercați să faceți comentariile cât mai scurte și concise posibil.
