În această lecție, vom discuta despre docstringuri și cum să le folosim în programele noastre Python. Docstringurile sunt șiruri de caractere care descriu funcțiile și metodele noastre, oferind informații despre modul în care acestea trebuie utilizate și ce rezultate se așteaptă de la ele.
Un docstring trebuie să fie plasat în partea de sus a funcției și să înceapă cu trei ghilimele. Aceasta poate fi o singură linie sau un șir multiplu de linii, în funcție de cât de detaliat doriți să fie. În general, ar trebui să descrie ceea ce face funcția, argumentele și valorile returnate.
Iată un exemplu de docstring pentru o funcție care adaugă două numere întregi:
def add_numbers(a, b):
"""
Returnează suma a două numere întregi.
Argumente:
a -- primul număr întreg
b -- al doilea număr întreg
Returnează:
Suma a și b
"""
return a + b
În acest exemplu, docstringul descrie ce face funcția, argumentele pe care le primește și ce returnează. Aceste informații sunt utile pentru utilizatorii funcției și pentru dezvoltatorii care vor lucra cu codul dvs.
În general, este o bună practică să utilizați docstringuri în toate funcțiile și metodele dvs. Python. Acestea ajută la documentarea codului dvs. și la îmbunătățirea citibilității acestuia pentru alți dezvoltatori.