1. Python tili imkoniyatlari Pythonni ko`chirish


Hujjatlashtirishning ko`p satrli ko`rinishlari



Yüklə 2,19 Mb.
səhifə54/78
tarix19.12.2023
ölçüsü2,19 Mb.
#152124
1   ...   50   51   52   53   54   55   56   57   ...   78
1. Python tili imkoniyatlari Pythonni ko`chirish

Hujjatlashtirishning ko`p satrli ko`rinishlari


Ko`p satrli hujjatlashtirish bir satrli matn, undan keyin bir satr bo`sh joy va undan keyin esa bir nechta satrlardan kengroq tushuncha berishdan iborat bo`ladi. Birinchi satr avtomatlashtirilgan indeksatsiya (izlash) xizmatlari tomonidan foydalanilishi mumkin, shuning uhcun ham uni bir satrda joylashtirish hamda undan keyin bitta bo`sh joy qoldirish muhimdir. Birinchi satr ochilayotgan qo`shtirnoqlar bilan bir satrda yoki keyingi satrda joylashishi mumkin. Butun hujjatlashtirish birinchi satrdagi qo`shtirnoqlar bilan bir xildagi siljishlarga ega bo`lishi kerak.
Klasslarni hujjatlashtirayotgan har bir bir qatorli yoki ko`p qatorli hujjatlashtirish qismlaridan keyin va undan oldin bir qatordan bo`sh satr qoldiring. Umuman olganda klasslarning metodlari bir-biridan bitta bo`sh qator bilan ajratiladi, hujjatlashtirish satri esa, birinchi metoddan bitta bo`sh joy surilib yoziladi. Simmetriyaga erishish maqsadida klass sarlavhasi hamda hujjatlashtirish satrlari orasida ham bitta bo`sh joy qoldiring. Funksiya va metodlarning hujjatlashtirish satrlariga esa, odatda, bunday talablar qo`yilmaydi.
Skriptlarning (mustaqil dasturlarning) hujjatlashtirish satrlari dastur biror xato yoki mavjud bo`lmagan argumentlar bilan chaqirilganda (yoki yordam uchun “-h” opsiyasi bilan chaqirilganda) qo`llanish ma`lumotnomasi” tarzida hosilbo`lish imkoniyatiga ega bo`lishi kerak. Bunday hujjatlashtirish satrlari dastur funksiyalari va buyruq satri sintaksisi, muhit o`zgaruvchilari va fayllarini hujjatlashtirishi kerak. “Qo`llanish ma`lumotnomasi” ancha murakkab bo`lishi (bir nechta ekrandan iborat bo`lishi) va yangi foydalanuvchi tomonidan dasturni muammosiz foydalana olishi uchun yetarli hamda shu bilan birga tajribali foydalanuvchi uchun barcha qo`shimcha imkoniyatlar haqida ma`lumot beradigan darajada mukammal bo`lishi talab etiladi.
Modullarning hujjatllashtirish satrlari, odatda, modul tomonidan eksport qilinadigan klasslar, noodatiy holatlar, funksiyalar (va har qanday boshqa ob`yektlar)ni ularning har biri uchun qisqa, bir satrli izohlar bilan sanab o`tilishidan iborat bo`lishi kerak. (Bu satrlar odatda, shu ob`yekt uchun birinchi hujjatlashtirish satrlaridan ko`ra ozroq ma`lumot beradi). Modullar paketlarining hujjatlashtirish satrlari (ya`ni, __init__.py dagi hujjatlashtirish satrlari) xuddi shunday modullar va paket ostilarni o`z ischiga olishlari kerak.
Funksiya yoki metodning hujjatlashtirish satrlari ularning vazifalari hamda argumentlari, qaytaradigan qiymatlari, kutilmagan holatlari, noodatiy holatlari, qo`shimcha argumentlari, nomlangan argumantlari hamda funksiyani chaqirishdagi cheklovlarni jamlashi kerak.
Klasslarning hujjatlashtirish satrlari uning uning vazifasini tushuntirib, o`chiq metodlari hamda ekzeplyar o`zgaruvchilarini sanab o`tadi. Agar klass klass ostilar uchun mo`ljallangan bo`lsa va klass ostilar uchun qo`shimcha interfeysga ega bo`lsa, bu interfeys alohida (hujjatlashtirish satrlarida) ko`rsatilishi kerak. Klass konstruktori __init__ metodining hujjatlashtirilishida ko`rsatilishi kerak. Alohida metodlar o`zlarining alohida hujjatlashtirish satrlariga ega bo`lishlari talab etiladi.
Agar klass boshqa klassning klass osti bo`lsa va uning vazifalari asosan shu klassdan olingan bo`lsa, hujjatlashtirish satrlarini buni ko`rsatib o`tishlari hamda farqlarini belgilashlari kerak bo`ladi. Klass osti metodi super klassning metodini almashtirayotganligi hamda uni chaqirmasligini bildirish maqsadida “override” fe`lidan foydalaning; Klass osti metodi super klassning metodini chaqirishni (o`zining vazifasiga qo`shimcha tarzda) ko`rsatish uchun esa “extend” fe`lini qo`llang.
Va yakunida misol:

def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0: return complex_zero
...

Pythonning standart kutubxonasida bundan ham ko`proq misollarni ko`rishingiz mumkin (Masalan python interpretatoringizning Lib papkasida).


27-bob


Yüklə 2,19 Mb.

Dostları ilə paylaş:
1   ...   50   51   52   53   54   55   56   57   ...   78




Verilənlər bazası müəlliflik hüququ ilə müdafiə olunur ©genderi.org 2024
rəhbərliyinə müraciət

    Ana səhifə