Learning About Docstring

Docstringlar haqida o'rganish

Python'da PEP, ya'ni Python Enhanshment Proposal (Pythonni rivojlantirish taklifi) tushunchasi mavjud. Ushbu PEP'lar Python tili uchun takliflar yoki yangi xususiyatlar bo'lib, Python Boshqaruv Kengashi tomonidan muhokama qilinadi va kelishiladi.

PEP 257 (https://www.python.org/dev/peps/pep-0257/) docstring konventsiyalarini tavsiflaydi. Agar xohlasangiz, to'liq hikoyani o'qishingiz mumkin. Qisqasi, docstring bu modullar, funktsiyalar, klasslar yoki metodlar ta'rifi ichidagi birinchi bayonot bo'lishi kerak bo'lgan satr literalidir. Hozirda bu atamalarni tushunishingiz shart emas. Aslida, siz bu haqda kitobimizning keyingi boblarida ko'proq ma'lumot olasiz.

Docstring uchta qo'shtirnoq yordamida yaratiladi. Quyida bir misol keltirilgan:

1"""
2 Bu bir docstring
3 bir nechta qatordan iborat
4"""

Docstringlar Python tomonidan e'tiborsiz qoldiriladi. Ular bajarilmaydi. Biroq, agar siz docstringni modul, funktsiya va hokazo birinchi bayonoti sifatida ishlatsangiz, docstring doc orqali kirish mumkin bo'lgan maxsus atributga aylanadi. Atributlar va docstringlar haqida ko'proq ma'lumotni klasslar haqidagi bobda bilib olasiz.

Docstringlar bir qatorli yoki bir nechta qatordan iborat satrlar uchun ishlatilishi mumkin. Quyida bir qatorli docstring misoli keltirilgan:

Bir qatorli docstring

1 """Bu bir qatorli docstring"""

Bir qatorli docstring — bu faqat bitta matn qatoriga ega bo'lgan docstringdir. Quyida funktsiyada ishlatilgan docstring misoli keltirilgan:

1 def my_function():
2     """Bu funktsiyaning docstringi"""
3     pass

Yuqoridagi kodda funktsiyaga docstring qanday qo'shilishini ko'rishingiz mumkin. Funktsiyalar haqida ko'proq ma'lumotni 14-bobda bilib olasiz. Yaxshi docstring funktsiyaning nima maqsadda yaratilganini ta'riflaydi.

Endi Pythonning uslub qo'llanmasiga muvofiq kodlash haqida o'rganamiz.