পাইথনে ফাংশনের ডকুমেন্টেশন দেখানো

ফাংশনের বডিতে, করা কাজের সারাংশ বর্ণনা করা একটি স্ট্রিং লেখা যেতে পারে। এই ধরনের স্ট্রিংকে সাধারণত ফাংশনের ডকুমেন্টেশন হিসাবে বিবেচনা করা হয়। এটি একক উদ্ধৃতির মধ্যে আবদ্ধ থাকে এবং ফাংশন বডির প্রথম লাইনে স্থাপন করা হয়। এটি পড়তে, আপনাকে একটি বিশেষ ফাংশন 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__)