Funksiyaların sənədləşdirilməsi

Python proqramlaşdırma dilində hazırladığımız funksiyaların nə işə yaradığına dair qısa izahat vermək üçün onları sənədləşdirə bilərik. Bu həm funksiyalarımızdan istifadə edəcək digər proqramçılar, həm də zaman keçdikcə özümüz üçün faydalı olacaqdır. Axı biz insanıq, nəyi nə üçün yazdıqlarımızı da getdikcə unuda bilərik. Bax belə vəziyyətlərdə funksiyalarımızın sənədləşmə sətirləri (docstrings) ilə təchiz olunması işimizə çox yarayacaq.

Sənədləşmə sətirləri funksiya başlığından sonra üç qoşa dırnaq (“””) işarələri arasında bir neçə sətirdə yazılır. Funksiya sənədləşdirilərkən onun təyinatı, parametr və qaytardığı qiymətin tipi göstərilməlidir. Üstəlik, funksiyadan istifadə edilməsinə dair nümunələr də verilə bilər.
Gəlin faktorialı hesablayan funksiyanı sənədləşdirək:

>>> def fakt(n): 
    """
    Returns factorial of a given 
    number using recursion.

    (num) -> num

    fakt(5) -> 120 
    """
    if n <= 1:
        return 1 
    else:
        return n * fakt(n-1)

>>>

Hər hansı bir funksiyanın sənədləşmə sətirlərini görmək üçün onun __doc__ atributundan və ya help() funksiyasından istifadə etmək olar:

>>> print(fakt.__doc__)

        Returns factorial of a given 
        number using recursion.

        (num) -> num

        fakt(5) -> 120
>>>
>>> help(fakt)
Help on function fakt in module __main__:

fakt(n)
    Returns factorial of a given 
    number using recursion.

    (num) -> num

    fakt(5) -> 120 

>>>

Funksiyaların sənədləşdirilməsi” üçün bir şərh

Şərh üçün bağlıdır.