Python-daky funksiýa dokumentasiýasyny çykarmak
Funksiýanyň bedeninde, amala aşyrylýan işiň mazmunyny beýan edýän setir ýazyp bolýar. Beýle setir funksiýanyň dokumentasiýasy hökmünde kabul edilýär. Ol bir sary dyrnak içine alynýar we funksiýanyň bedeniniň birinji setirinde ýerleşdirilýär. Ony okamak üçin ýörite help funksiýasy ulanylýar, onuň parametrine funksiýanyň ady berilýär.
Iki sany sanlary jemleýän funksiýamyz bardygyny düşüneli. Bu barada degişli maglumatly setir goýuldy:
def getSum(num1, num2):
'bu funksiýa iki sany jemleýär'
return num1 + num2
help-i çagyryp, getSum-da näme düşündirilendigini bileliň:
help(getSum)
Kod ýerine ýetirilenden soň, konsolda funksiýanyň ady we onuň dokumentasiýasy bilen setir peýda bolar:
Help on function getSum in module __main__:
getSum(num1, num2)
bu funksiýa iki sany jemleýär
help funksiýasy standart funksiýalaryň hem dokumentasiýasyny okap bilmek üçin ulanylýar. print funksiýasy barada maglumaty bileliň:
help(print)
Funksiýadan diňe dokumentasiýa setirini çykarmak üçin, help-e funksiýanyň adyndan soň hyzmat amaly konstruksiýa .__doc__ berilmelidir:
help(print.__doc__)
Aýlaryň atlarynyň sanawyny parametr hökmünde kabul eden we olary baş harp bilen çykarýan funksiýa dörediň. Funksiýanyň işiniň mazmunyny dokumentasiýada düşündiriň we ony konsolda çykaryň.
sum funksiýasy baradaky tutuş dokumentasiýany çykaryň.
len funksiýasy baradaky diňe dokumentasiýa setirini çykaryň.