আমি লিনাক্স এবং ফ্রিবিএসডি-র জন্য একটি ছোট সি লাইব্রেরি লিখেছি এবং আমি এটির জন্য ডকুমেন্টেশন লিখতে চলেছি। আমি ম্যান পেজ তৈরি করার বিষয়ে আরও জানার চেষ্টা করেছি এবং লাইব্রেরির জন্য ম্যান পেজ তৈরির সেরা অভ্যাসের নির্দেশাবলী বা বিবরণ পাইনি। বিশেষত আমি ফাংশনের ম্যান পেজগুলি কী বিভাগে রাখতে আগ্রহী? 3? সম্ভবত সেখানে ভাল উদাহরণ বা ম্যানুয়াল আছে? লাইব্রেরি থেকে প্রতিটি ফাংশনের জন্য ম্যান পেজ তৈরি করা খারাপ ধারণা?
উত্তর:
একটি লাইব্রেরির জন্য ম্যানুয়াল পৃষ্ঠাগুলি 3 বিভাগে যেতে হবে।
ম্যানুয়াল পৃষ্ঠাগুলির ভাল উদাহরণগুলির জন্য, মনে রাখবেন যে কিছু গ্রোফের নির্দিষ্ট বিবরণ ব্যবহার করে এবং / অথবা নির্দিষ্ট ম্যাক্রোগুলি ব্যবহার করে যা সত্যই বহনযোগ্য নয় written
ম্যান-পৃষ্ঠাগুলির বহনযোগ্যতার ক্ষেত্রে সর্বদা কিছু সমস্যা রয়েছে কারণ কিছু সিস্টেম বিশেষ বৈশিষ্ট্যগুলি ব্যবহার করতে পারে (বা নাও পারে)। উদাহরণস্বরূপ, ডকুমেন্টিংয়ের ক্ষেত্রে, dialogউদাহরণ প্রদর্শনের জন্য আমাকে বিভিন্ন সিস্টেমে পার্থক্য মনে রাখতে হবে (এবং কাজ করা) (যা ন্যায়সঙ্গত নয়)।
শুরু করুন পড়া প্রাসঙ্গিক অংশগুলি man manযেখানে এটি মান ম্যাক্রো উল্লেখ, এবং তুলনা FreeBSD 'র এবং Linux জন্য ঐ বিবরণ।
আপনি গ্রন্থাগারের জন্য একটি ম্যানুয়াল পৃষ্ঠা লিখতে বা ফাংশনগুলির জন্য পৃথক ম্যানুয়াল পৃষ্ঠাগুলি (বা ফাংশনগুলির গোষ্ঠীগুলি) বেছে নেওয়ার বিষয়টি নির্ভর করে: ফাংশনগুলির বিবরণটি কতটা জটিল হবে তার উপর নির্ভর করে:
আরও পড়া:
আমি ব্যবহার ronn । আপনি কেবল মার্কডাউন লিখুন, এবং এটি এটিকে একটি ম্যানপেজে পরিণত করবে। এটির একটি (কিছুটা কম সক্ষম) জেএস ক্লোনও রয়েছে যা চিহ্নিত-ম্যান বলে ।
আমি এর সাথে END_MANবাদ দিয়ে একই END_MANসীমাবদ্ধ বংশগতি ব্যবহার করে সীমিত সীমানা এবং আমার সি / সি ++ কোড ব্যবহার করে এর সাথে আমার স্ক্রিপ্টগুলি নথিবদ্ধ করছি /* */। হয় সেডের সাথে সহজেই নিষ্কর্ষযোগ্য এবং তারপরে একটি ম্যানপেজে রেন্ডারযোগ্য। (ইনোটিফয়েটের পাশাপাশি ইউএনআইএক্স সিগন্যাল হ্যাকারিটির সাথে সামান্য কিছু অংশের সাহায্যে আপনি আপনার ম্যানপেজ বিভাগগুলি লাইভ বের করতে এবং দেখতে পারবেন এবং ম্যানপেজ ব্রাউজারটি উত্স আপডেট হিসাবে পুনরায় লোড করতে পারেন))
বিভাগ হিসাবে, তারপর 3 এটি ব্যবহারকারীর স্তরের সি লাইব্রেরির জন্য হবে। আপনি মানুষের (1) বিভাগের নম্বরগুলি (অন্যান্য জিনিসের মধ্যে) সম্পর্কে পড়তে পারেন ।
আপনি কিছু পাঠযোগ্য, ভাল কাঠামোগত উদাহরণ man পৃষ্ঠা দেখতে চান, আমি Plan9 কটাক্ষপাত করা চাই https://swtch.com/plan9port/unix/ লাইব্রেরি যেখানে আপনি কীভাবে খুব স্রষ্টাদের দেখতে পারেন cএবং UNIXএবং তার ডকুমেন্টেশন সিস্টেম সম্ভবত এই জিনিসগুলি কাজ করার উদ্দেশ্যে তৈরি হয়েছিল।
অন্য উত্তরগুলির পরিপূরক হিসাবে, আরেকটি মার্কডাউন ভাষা যা ম্যান পেজগুলি লেখার সহজ করতে ব্যবহার করা যেতে পারে সেটি হ'ল রিস্ট্রাকচারটেক্সট এবং rst2man কমান্ড যা পাইথন-ডকুমেন্টাল প্যাকেজের অংশ।
এই মার্কডাউন ভাষাটি তার ডকুমেন্টেশনের জন্য অজগর দ্বারা গৃহীত হয়েছে এবং ভাল পুরাতন ট্রফ ম্যান ম্যাক্রোগুলির চেয়ে আর্স্ট 2ম্যান আপনার পুনর্গঠিত পাঠ্যক্রম থেকে আপনার জন্য উত্সাহিত করবে তার চেয়ে শেখা, লিখতে এবং বজায় রাখা আরও সহজ।
আপনি এইচটিএমএল হিসাবে রেফারেন্স সরবরাহ করতে ডক্সিজন ব্যবহার করে এপিআই নথি করতে পারবেন এবং অফলাইনে পড়ার জন্য ম্যান পৃষ্ঠা এবং অন্যান্য ফর্ম্যাট তৈরি করতে পারেন।
ডক্সিজেনের সুবিধা হ'ল এটি জাভাডক বা পাইথনডকের মতো "ইনলাইন" ডকুমেন্টেশন, ইন্টারফেস মন্তব্য হিসাবে দ্বিগুণ (বা ভিভি। আপনি আপনার উত্স / শিরোলেখ ফাইলগুলিতে ডক পাঠ্য যুক্ত করুন এবং এটি সেখান থেকে উত্তোলন করা হয়েছে যা আপ টু ডেট থাকার সম্ভাবনা উন্নত করে।
manস্ট্যান্ডার্ড লাইব্রেরি এবং সিস্কল ছাড়া প্রোগ্রামিংয়ের জন্য কখনও ব্যবহার করি না ।