Python-da funksiyanin sənədləşdirilməsinin çıxarılması

Funksiyanın gövdəsində, görülən işin mahiyyətini təsvir edən bir sətir yazıla bilər. Belə bir sətir adətən funksiyanın sənədləşdirilməsi hesab olunur. O, tək dırnaqlar içinə alınır və funksiya gövdəsinin birinci sətirində yerləşdirilir. Onu oxumaq üçün help xüsusi funksiyasından istifadə etmək lazımdır, onun parametrinə isə funksiyanın adı ötürülür.

Tutaq ki, iki ədədi toplayan bir funksiyamız var. Bununla əlaqədar müvafiq məlumat olan bir sətir əlavə edilib:

pythondef getSum(num1, num2):
  'this function sums two numbers'
  return num1 + num2

Gəlin help çağıraq və getSum funksiyasında nəyin şərh edildiyini öyrənək:

pythonhelp(getSum)

Kodu icra etdikdən sonra konsolda funksiyanın adı və onun sənədləşdirilməsi olan bir sətir peyda olacaq:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

help funksiyası vasitəsilə standart funksiyaların sənədləşdirilməsini də oxumaq olar. Gəlin print funksiyası haqqında məlumat əldə edək:

pythonhelp(print)

Funksiyadan yalnız sənədləşdirmə sətirini çıxarmaq üçün, help funksiyasına funksiyanın adından sonra .__doc__ xidməti konstruksiyasını ötürmək lazımdır:

pythonhelp(print.__doc__)