1. Şərhlər necə yazılır
Python-da, digər bir çox proqramlaşdırma dillərində olduğu kimi, kodda şərhlər yaza bilərsiniz.
Şərhlər — bu sadəcə digər proqramçılar üçün olan mətndir: Python-interpreter onları heç bir cür qəbul etmir və şərhlərdə yazılmış kodu icra etmir. Şərhlər proqramçılar və layihə iştirakçılarının kodu anlamasına kömək edir, bu isə xüsusilə komanda işi və uzunmüddətli dəstəkdə çox faydalıdır. Python-da koda şərh əlavə etməyin bir neçə yolu var.
Tək sətirlik şərhlər:
# simvolu ilə başlayır. Eyni sətrdə # simvolundan sonra yazılan hər şey Python interpreteri tərəfindən nəzərə alınmır. Bu tip şərhlər adətən hansısa mətnə qısa qeydlər və ya izahlar üçün istifadə olunur. Məsələn:
# Bu tək sətirlik şərhdir
print("Hello, World!") # Funksiyanın əməliyyatına izah
Çoxsətirli şərhlər:
Python-da çoxsətirli şərhlər üçün xüsusi sintaksis yoxdur, amma onları bir neçə tək sətirlik şərh ilə və ya triple-qeyd ilə yarada bilərsiniz. Amma qeyd edək ki, triple-qeyd əslində sadəcə çoxsətirli string literalıdır və kod kimi işlədilmir. Məsələn:
# Bu çoxsətirli şərh nümunəsidir
# Hər sətir `#` simvolu ilə başlayır
və ya:
""" Bu çoxsətirli literal, şərh olaraq istifadə edilə bilər. Python bunu sadəcə string kimi qəbul edir, amma bu string heç bir dəyişənə təyin olunmazsa və ya ifadədə istifadə edilməzsə, heç bir əməliyyat aparılmır. """
Faydalıdır! Literal — kodun içində birbaşa yazılmış kiçik bir məlumat parçasıdır: rəqəm, sətir və s.
2. Şərhləri niyə yazmaq lazımdır?
Kodda şərhlərdən istifadə onun oxunaqlılığını artırır, dəstəklənməsini və yenilənməsini asanlaşdırır, həmçinin komandada daha effektiv birgə işə kömək edir. Şərhlər qısa, lakin məlumatlı və aktual olmalıdır ki, kodun faydalı sənədləşməsi kimi xidmət etsin və onu lazımsız məlumatlarla yükləməsin.
Sənədləşdirici sətirlər (docstrings):
Bunlar əsasən modulların, siniflərin, metodların və funksiyaların başlanğıcında onların məqsədini təsvir etmək üçün yerləşdirilən çoxsətirli sətirlərdir. Onlar üç cüt qoşa dırnaq işarəsi arasında yazılır və sənədlərin avtomatik yaradılması üçün istifadə olunur.
Nümunə:
def add(a, b): """ İki ədədin cəmini hesablamaq üçün funksiya. :param a: birinci toplanan :param b: ikinci toplanan :return: a və b-nin cəmi """ return a + b
Proqramlaşdırma dünyasında bəzi tərtibatçılar kodlarına yalnız izah məqsədi ilə deyil, həm də təbəssüm yarada biləcək şərhlər əlavə edirlər. İşdə kodda rast gəlinə biləcək bəzi əyləncəli şərhlər:
Nümunə 1:
# Burada nə baş verdiyini izah edərdim, amma artıq özüm də bilmirəm.
Nümunə 2:
# Əgər bu işləmir, günahkar başqasıdır.
Nümunə 3:
# Gəldim, gördüm, düzəltdim... və xarab etdim.
Nümunə 4:
# Mən bunu yazanda, yalnız mən və Tanrı bunun necə işlədiyini bilirdik.
# İndi isə yalnız Tanrı bilir.
Nümunə 5:
# Buraya boş yerə sərf olunan saatların sayı = 42.
Bu şərhlər inkişaf prosesinə bir az yüngüllük və yumor əlavə edə bilər, kod bazasını daha az monoton edir. Həmçinin, proqram təminatının hazırlanmasının yaradıcı və insani proses olduğunu xatırladır.
5.3 Kodu tez şərhə almaq
PyCharm IDE-də kodunuzu tez bir zamanda şərhə ala və ya şərhdən çıxara bilərsiniz, bunun üçün qısa yollar var. Bunun üçün şərhə almaq və ya şərhdən çıxarmaq istədiyiniz kod sətirlərini seçin və Windows üçün Ctrl + / (və ya macOS üçün Cmd + /) düymələrini basın. Bu kombinasiya hər bir seçilmiş sətirdə şərh simvolunu tətbiq edir və ya çıxarır, bu prosesi sürətli və effektiv edir.
GO TO FULL VERSION