ভূমিকা
pydoc মডিউল পাইথন মডিউল থেকে অটোমেটিকালি ডকুমেন্টেশন জেনারেট করে। ডকুমেন্টেশন কনসোলে টেক্সট, ব্রাউজারে, বা HTML ফাইল হিসেবে সেভ করা যায়।
এখানে ডকুমেন্টেশন ভিউ করার পদ্ধতি ও নিজস্ব ডকুমেন্টেশনের জন্য docstring শিখব।
শুরু করা
pydoc পাইথনের সাথে প্যাকেজড। ইম্পোর্ট করুন:
import pydoc
help() ফাংশন দিয়ে ইন্টারঅ্যাক্টিভ শেল
টার্মিনালে পাইথন ইন্টারঅ্যাক্টিভ শেল খুলুন, pydoc ইম্পোর্ট করে pydoc.help() চালান।
>>> import pydoc
>>> pydoc.help()
এখন মডিউল, ডেটা টাইপ, ফাংশন, ক্লাসের নাম লিখে ডকুমেন্টেশন পাওয়া যাবে।
ব্রাউজারে ডকুমেন্টেশন দেখা
টার্মিনাল থেকে সরাসরি:
python -m pydoc -b
লোকাল সিস্টেমের সব পাইথন মডিউল, ফাংশন, অবজেক্টের ডকুমেন্টেশন ব্রাউজারে জেনারেট হবে। কীওয়ার্ড সার্চও করা যাবে।
C:\Users\vijay>python -m pydoc -b
Server ready at https://localhost:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped
Docstring দিয়ে নিজস্ব ডকুমেন্টেশন
উদাহরণ
def documentation():
'''Documentation using docstrings'''
print(documentation.__doc__)
help(documentation)
আউটপুট
Documentation using docstrings
Help on function documentation in module __main__:
documentation()
Documentation using docstrings
উপসংহার
pydoc দিয়ে অফলাইনে পাইথন কীওয়ার্ড, ফাংশন, মডিউল, মেথডের ডকুমেন্টেশন পড়া যায়। Docstring দিয়ে নিজস্ব ডকুমেন্টেশন তৈরি করা যায়। বড় প্রজেক্টে ভালো ডকুমেন্টেশন রক্ষা কনফিউশন ও রানটাইম এরর কমাতে সাহায্য করে।
