একটি প্রকল্পের জন্য, আমাকে কিছু পুরানো গেম এবং সম্পর্কিত সফ্টওয়্যার - কনফিগারেশন ফাইল, সংরক্ষণ, সংস্থান সংরক্ষণাগার ইত্যাদি থেকে বিভিন্ন ধরণের ফাইলের সাথে কাজ করা উচিত। এগুলির বেশিরভাগটি এখনও নথিভুক্ত নয়, বা তাদের সাথে কাজ করার জন্য কোনও সরঞ্জাম উপস্থিত নেই, সুতরাং আমাকে অবশ্যই ফর্ম্যাটগুলি রিভার্স-ইঞ্জিনিয়ার এবং সেগুলি পরিচালনা করার জন্য আমার নিজস্ব লাইব্রেরি তৈরি করতে হবে।
যদিও আমি মনে করি না এটির বেশিরভাগের জন্য প্রচুর চাহিদা রয়েছে, তবে আমি আমার প্রচেষ্টার ফলাফল প্রকাশের ইচ্ছা করি। ফাইল ফর্ম্যাটের ডকুমেন্টিংয়ের জন্য কি কোনও গৃহীত মান আছে? চারপাশে তাকালে, বেশ কয়েকটি শৈলীর ব্যবহার রয়েছে: কিছু .ZIP ফাইল ফর্ম্যাট স্পেসিফিকেশন এর মতো খুব শব্দযুক্ত; অন্যরা, যেমন এক্সএন্ট্যাক্সউইকির মতো, তারা আরও বেশি পরিশ্রুত - তাদের মধ্যে কিছু পড়তে আমার অসুবিধা হয়; প্লেস্টেশন 2 মেমরি কার্ড ফাইল সিস্টেমের এই বিবরণটি যা আমি ব্যক্তিগতভাবে সবচেয়ে বেশি পছন্দ করি তা হ'ল অফসেট এবং এর সাথে বিশদ বর্ণনামূলক পাঠ্য এবং কয়েকটি 'মেমরি মানচিত্র' উভয়ই অন্তর্ভুক্ত - এটি আমার ব্যবহারের ক্ষেত্রেও খুব ঘনিষ্ঠভাবে মেলে। এটি বিভিন্ন ফর্ম্যাটের জন্য কিছুটা পৃথক হবে, তবে মনে হচ্ছে কিছু সাধারণ নীতি থাকতে হবে যা অনুসরণ করার চেষ্টা করা উচিত।
সম্পাদনা: আমি যা করতে চাই তা খুব ভালভাবে ব্যাখ্যা করেছি বলে মনে হচ্ছে না। আমি একটি উদাহরণ নির্মাণ করি।
আমার কাছে কিছু পুরানো সফটওয়্যার থাকতে পারে যা এর কনফিগারেশনটি একটি 'বাইনারি' ফাইলে সংরক্ষণ করে - বিটফিল্ড, ইন্টিজার, স্ট্রিংগুলির একটি ধারাবাহিক, এবং কী না সমস্তই একসাথে আটকানো হয় এবং প্রোগ্রামটি বোঝে, তবে মানব-পঠনযোগ্য নয়। আমি এই বোঝা। এই ফাইলটি বিশ্লেষণ ও সংশোধন করার জন্য একটি লাইব্রেরি বাস্তবায়নের জন্য একটি বিশদ হিসাবে, মানব-পঠনযোগ্য উপায়ে এই ফাইলটির ফর্ম্যাটটি হুবহু ডকুমেন্ট করতে চাই। অতিরিক্ত হিসাবে, আমি এটি অন্য লোকেরা সহজেই বোঝে।
এই জাতীয় দলিল লিখিত হতে পারে বিভিন্ন উপায়। উপরের পিকেজিআইপি উদাহরণটি খুব শব্দযুক্ত এবং বেশিরভাগ ক্ষেত্রে ফ্রি ফর্ম্যাটটিকে ফ্রি পাঠ্যে বর্ণনা করে। PS2 উদাহরণ মানগুলির ধরণ, অফসেট এবং আকারগুলির সারণী দেয়, সেগুলির অর্থ কী তা নিয়ে বিস্তৃত মন্তব্য। এক্সএন্ট্যাক্সউইকির মতো আরও অনেকেই কেবল পরিবর্তনশীল প্রকার এবং আকারগুলি তালিকাবদ্ধ করে খুব কম বা কোনও মন্তব্য না করেই।
আমি জিজ্ঞাসা করি কোনও কোডিং শৈলীর গাইডের অনুরূপ কোনও মানদণ্ড রয়েছে কি না, যা এই জাতীয় ডকুমেন্টেশন কীভাবে লিখতে হয় তার জন্য গাইডেন্স সরবরাহ করে। যদি তা না হয় তবে এমন কোনও সুপরিচিত চমৎকার উদাহরণ আছে যা আমার অনুকরণ করা উচিত? যদি তা না হয় তবে কেউ কি কমপক্ষে কিছু দরকারী পরামর্শের সংক্ষিপ্ত বিবরণ দিতে পারেন?
struct
। এটি বেশ ভাল কাজ করেছে।