পাইথন ডকস্ট্রিংস

কোডের কিছু অংশ বুঝতে আমরা পাইথন প্রোগ্রামে কোডটি মন্তব্য করতে পারি। কিন্তু মন্তব্য এবং মন্তব্যের বিভিন্ন অংশ অনুসন্ধান করার জন্য আমাদের অনুসন্ধান (CTL+F) ব্যবহার করতে হবে এবং আমরা অনেক লাইন স্ক্রোল করি। এছাড়াও কোডের কতগুলি বিভাগ ইত্যাদির সাথে একটি প্রদত্ত শব্দ জড়িত তা জানার তাৎক্ষণিক উপায় আমাদের কাছে নেই৷ এই সমস্যাগুলি সমাধান করার জন্য, আমাদের কাছে পাইথন ডকস্ট্রিং রয়েছে যা একটি ফাংশন, মডিউল, শ্রেণী বা পদ্ধতির সংজ্ঞার সাথে সাথে স্ট্রিংগুলি অ্যাক্সেস করে৷

একটি ডকস্ট্রিং প্রিন্ট করুন

__doc__ বৈশিষ্ট্যটি স্বয়ংক্রিয়ভাবে পাইথন অবজেক্টের নামের সাথে যুক্ত হয় যখন এটি সেই বস্তুর সংজ্ঞার পরপরই ঘোষণা করা হয়। নীচের উদাহরণগুলি যা স্পষ্ট করে৷

উদাহরণ

def Add_nums(x):
   '''Ada a number to itself.'''
   return x + x
print(Add_nums.__doc__)

আউটপুট

উপরের কোডটি চালানো আমাদের নিম্নলিখিত ফলাফল দেয় -

Ada a number to itself.

একক লাইন বনাম মাল্টিলাইন ডকসরিংস

একক-লাইন ডকস্ট্রিংগুলি এক লাইনের এবং সেগুলি খুব বেশি বর্ণনামূলক হওয়া উচিত নয়। এগুলি স্ট্রিংয়ের শুরুতে এবং শেষে ট্রিপল উদ্ধৃতিগুলির মধ্যে আবদ্ধ। উপরের উদাহরণটি হল একটি একক লাইন ডকস্ট্রিং৷

মাল্টি-লাইন ডকস্ট্রিং

কখনও কখনও আমাদের আরও বিস্তারিতভাবে মডিউল বা ফাংশন বর্ণনা করতে হতে পারে। সেক্ষেত্রে আমরা মাল্টি-লাইন ডকস্ট্রিং ব্যবহার করি। তারা একটি সারাংশ লাইন দেখায় ঠিক যেমন একটি এক-লাইন ডকস্ট্রিং এবং তারপরে একটি ফাঁকা লাইন, তার পরে আরও বিস্তৃত বিবরণ।

উদাহরণ

def Fibonacci(n):
   '''The Fibonacci numbers are the numbers in the following integer sequence.
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, .'''
   return x + x
print(Fibonacci.__doc__)

আউটপুট

উপরের কোডটি চালানো আমাদের নিম্নলিখিত ফলাফল দেয় -

The Fibonacci numbers are the numbers in the following integer sequence.
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, .

ইন-বিল্ট পাইথন অবজেক্টের ডকস্ট্রিং

আমরা __doc__ এর সাথে ক্লাসের নাম ব্যবহার করে পাইথন বস্তুর মতো ফাংশন, মডিউল ইত্যাদির সাথে যুক্ত ডকুমেন্টেশন সহজেই অ্যাক্সেস করতে পারি।

উদাহরণ

print(list.__doc__)

আউটপুট

উপরের কোডটি চালানো আমাদের নিম্নলিখিত ফলাফল দেয় -

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list.
The argument must be an iterable if specified.

ডকস্ট্রিং-এ ইন্ডেন্টেশন

ডকস্ট্রিং এর প্রথম লাইনে যেকোন ইন্ডেন্টেশন (অর্থাৎ, প্রথম নতুন লাইন পর্যন্ত) তুচ্ছ এবং মুছে ফেলা হয়। ডকস্ট্রিং-এ পরবর্তী লাইনের আপেক্ষিক ইন্ডেন্টেশন বজায় রাখা হয়। সম্পূর্ণ ডকস্ট্রিং এর প্রথম লাইনের উদ্ধৃতিগুলির মতোই ইন্ডেন্ট করা হয়েছে৷