Introduction

Kodingizni Hujjatlash

Kodingizni erta hujjatlash yangi dasturchilar uchun ko'p hollarda tushunarsiz bo'lgan muhimligi haqida tushunchaga ega emaslar. Dasturiy ta'minotdagi hujjatlash, o'zgaruvchilar, funktsiyalar va boshqa identifikatorlarga ta'riflovchi nomlar berish g'oyasini anglatadi. Bu shuningdek, yaxshi izohlar qo'shishni ham anglatadi. Siz o'zingizning yangi yaratishingizni rivojlantirishga kirishganingizda, siz nomlarining ta'riflovchi bo'lmagan o'zgaruvchilar va funktsiyalarni yaratishni oson qabul qilasiz. Bir oy yoki bir yil o'tgach, sizning kodingizga qaytib kelganingizda, kodingiz nima qilayotganini tushunishga juda ko'p vaqt sarflaysiz.

Kodingizni o'z-o'zidan hujjatlash (ya'ni, ta'riflovchi nomlardan foydalanish) va zarur bo'lganda izohlar qo'shish orqali, kodingizni o'zingiz va kodingizdan foydalanadigan har qanday boshqa insonlar uchun yanada o'qilishi oson bo'ladi. Bu kodingizni yangilash va refaktoringni ham osonlashtiradi!

Ushbu bobda siz quyidagi mavzularni o'rganasiz:

• Izohlar
• Docstrings
• PEP8 - Python Stil Qo'llanmasi
• Kodingizni hujjatlash uchun foydali boshqa vositalar

Izohlar haqida o'rganishni boshlaymiz.