Ֆունկցիայի փաստաթղթավորման արտածումը Python-ում

Ֆունկցիայի մարմնում կարելի է գրել մի տող, որը նկարագրում է կատարվող աշխատանքի էությունը: Նման տողը ընդունված է համարել ֆունկցիայի փաստաթղթավորում: Այն տեղադրվում է միայնակ չակերտների մեջ և տեղակայվում է ֆունկցիայի մարմնի առաջին տողում: Այն կարդալու համար անհրաժեշտ է օգտագործել հատուկ ֆունկցիա help, որի պարամետրին փոխանցվում է ֆունկցիայի անունը:

Ենթադրենք, մենք ունենք երկու թիվ գումարող ֆունկցիա: Դրա մասին թողնված է տեղեկատվություն պարունակող տող.

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

Եկեք կանչենք help և պարզենք, թե ինչ է մեկնաբանված getSum-ում:

pythonhelp(getSum)

Կոդի կատարումից հետո կոնսոլում կհայտնվի տող ֆունկցիայի անվանումով և դրա փաստաթղթավորմամբ.

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

help ֆունկցիայի օգնությամբ կարելի է կարդալ նաև ստանդարտ ֆունկցիաների փաստաթղթավորումը: Եկեք պարզենք տեղեկատվություն print ֆունկցիայի մասին.

pythonhelp(print)

Ֆունկցիայից փաստաթղթավորման տողը միայնակ արտածելու համար, անհրաժեշտ է help-ին ֆունկցիայի անունից հետո փոխանցել սպասարկող կոնստրուկցիա .__doc__.

pythonhelp(print.__doc__)