एक परियोजना के लिए, मुझे कुछ पुराने गेम और संबंधित सॉफ़्टवेयर से विभिन्न प्रकार की फ़ाइलों के साथ काम करने की आवश्यकता है - कॉन्फ़िगरेशन फ़ाइलें, सहेजता है, संसाधन अभिलेखागार, और इसी तरह। इनमें से अधिकांश अभी तक प्रलेखित नहीं हैं, न ही उनके साथ काम करने के लिए उपकरण मौजूद हैं, इसलिए मुझे प्रारूपों को रिवर्स-इंजीनियर करना चाहिए और उन्हें संभालने के लिए अपने स्वयं के पुस्तकालयों का निर्माण करना चाहिए।
हालांकि मुझे नहीं लगता कि इसमें से अधिकांश के लिए बहुत मांग है, मैं अपने प्रयासों के परिणामों को प्रकाशित करने का इरादा रखता हूं। फ़ाइल स्वरूपों के दस्तावेज़ीकरण के लिए कोई स्वीकृत मानक हैं? चारों ओर देखते हुए, उपयोग में कई शैलियाँ हैं: कुछ, जैसे .ZIP फ़ाइल स्वरूप विशिष्टता , बहुत चिंताजनक हैं; अन्य, जैसे कि एक्सेंटैक्सविकी, बहुत अधिक प्रचलित हैं - मुझे लगता है कि उनमें से कुछ को पढ़ना मुश्किल है; व्यक्तिगत रूप से मुझे जो सबसे अच्छा लगता है , वह है PlayStation 2 मेमोरी कार्ड फाइल सिस्टम का यह वर्णन , जिसमें ऑफ़सेट्स के साथ विस्तृत वर्णनात्मक पाठ और कई 'मेमोरी मैप्स' दोनों शामिल हैं और यह भी - यह मेरे उपयोग के मामले से सबसे अधिक निकटता से मेल खाता है। यह अलग-अलग प्रारूपों के लिए थोड़ा अलग होगा, लेकिन ऐसा लगता है कि कुछ सामान्य सिद्धांत होने चाहिए जिनका मुझे पालन करने की कोशिश करनी चाहिए।
संपादित करें: मुझे लगता है कि मैं जो करना चाहता हूं उसे बहुत अच्छी तरह से नहीं समझाया गया है। एक उदाहरण देता हूं।
मेरे पास कुछ पुराने सॉफ्टवेयर हो सकते हैं जो 'विन्यास' को 'बाइनरी' फ़ाइल में संग्रहीत करता है - बिटफ़िल्ड, पूर्णांक, स्ट्रिंग्स की एक श्रृंखला, और जो सभी एक साथ चिपके रहते हैं और प्रोग्राम द्वारा समझे जाते हैं, लेकिन मानव-पठनीय नहीं। मैं इसे समझती हूं। मैं वास्तव में इस फाइल का प्रारूप बनाना चाहता हूं, मानव-पठनीय तरीके से, इस फाइल को पार्स करने और संशोधित करने के लिए पुस्तकालय को लागू करने के लिए एक विनिर्देश के रूप में। इसके अतिरिक्त, मैं चाहूंगा कि इसे अन्य लोगों द्वारा आसानी से समझा जा सके।
इस तरह के दस्तावेज़ लिखे जाने के कई तरीके हैं। उपरोक्त PKZIP उदाहरण बहुत ही चिंताजनक है और ज्यादातर मुफ्त पाठ में फ़ाइल प्रारूप का वर्णन करता है। PS2 उदाहरण मूल्य प्रकार, ऑफसेट, और आकार की तालिका देता है, जिसमें वे सभी का मतलब है। XentaxWiki पर उन जैसे कई अन्य, केवल कम या कोई टिप्पणी के साथ चर प्रकार और आकारों को सूचीबद्ध करते हैं।
मैं पूछता हूं कि क्या कोई मानक है, कोडिंग स्टाइल गाइड के समान है, जो इस तरह के प्रलेखन को लिखने के बारे में मार्गदर्शन प्रदान करता है। यदि नहीं, तो क्या कोई प्रसिद्ध उदाहरण है जिसका मुझे अनुकरण करना चाहिए? यदि नहीं, तो क्या कोई कम से कम कुछ उपयोगी सलाह को संक्षेप में बता सकता है?
struct
। इसने काफी अच्छा काम किया।