একটি ফাংশন বা ডকুমেন্টেশন সম্পর্কে তথ্য একটি ফাংশনের ডকস্ট্রিং-এ রাখা হয়। ডকস্ট্রিং লেখার সময় নিম্নলিখিত নির্দেশিকাগুলি অনুসরণ করতে হবে৷
প্রথম লাইনটি সর্বদা বস্তুর উদ্দেশ্যের একটি সংক্ষিপ্ত, সংক্ষিপ্ত সারাংশ হওয়া উচিত। সংক্ষিপ্ততার জন্য, এটি স্পষ্টভাবে বস্তুর নাম বা প্রকার উল্লেখ করা উচিত নয়। এই লাইনটি একটি বড় অক্ষর দিয়ে শুরু হওয়া উচিত এবং একটি পিরিয়ড দিয়ে শেষ হওয়া উচিত৷
ডকুমেন্টেশন স্ট্রিং-এ যদি আরও লাইন থাকে, তাহলে দ্বিতীয় লাইনটি ফাঁকা থাকা উচিত, সারাংশটিকে বাকি বিবরণ থেকে দৃশ্যমানভাবে আলাদা করে
স্ফিংস
Sphinx হল সবচেয়ে জনপ্রিয় Python ডকুমেন্টেশন টুল। এটি পুনর্গঠিত পাঠ্য মার্কআপ ভাষাকে HTML, LaTeX (মুদ্রণযোগ্য PDF সংস্করণের জন্য), ম্যানুয়াল পৃষ্ঠা এবং প্লেইন টেক্সট সহ আউটপুট ফরম্যাটের একটি পরিসরে রূপান্তরিত করে।
যখন চালানো হয়, তখন স্ফিঙ্কস আপনার কোড আমদানি করবে এবং পাইথনের অন্তর্নিদর্শন বৈশিষ্ট্যগুলি ব্যবহার করে এটি সমস্ত ফাংশন, পদ্ধতি এবং ক্লাস স্বাক্ষর বের করবে। এটি সহগামী ডকস্ট্রিংগুলিও বের করবে এবং আপনার প্রোজেক্টের জন্য ভাল-গঠিত এবং সহজে পঠনযোগ্য ডকুমেন্টেশনে এটিকে কম্পাইল করবে৷
