สำหรับโครงการฉันต้องทำงานกับไฟล์ประเภทต่าง ๆ จากเกมเก่า ๆ และซอฟต์แวร์ที่เกี่ยวข้อง - ไฟล์กำหนดค่า, บันทึก, ไฟล์เก็บถาวรทรัพยากรและอื่น ๆ ส่วนใหญ่ของเอกสารเหล่านี้ยังไม่ได้จัดทำเอกสารและไม่มีเครื่องมือใดที่ทำงานร่วมกับพวกเขาได้ดังนั้นฉันต้องย้อนกลับสร้างรูปแบบและสร้างห้องสมุดของตัวเองเพื่อจัดการกับมัน
แม้ว่าฉันไม่คิดว่าจะมีความต้องการส่วนใหญ่เป็นอย่างมาก แต่ฉันตั้งใจจะเผยแพร่ผลลัพธ์ของความพยายามของฉัน มีมาตรฐานที่ยอมรับสำหรับรูปแบบไฟล์เอกสารหรือไม่? เมื่อมองไปรอบ ๆ นั้นมีหลายลักษณะที่ใช้งาน: บางอย่างเช่น. ZIP รูปแบบไฟล์สเปคนั้นดูดีมาก คนอื่น ๆ เช่นเดียวกับใน XentaxWiki นั้นเป็นคำศัพท์ที่สั้นกว่ามาก - ฉันพบว่าบางคนอ่านยาก สิ่งที่ฉันชอบที่สุดคือคำอธิบายของระบบไฟล์การ์ดหน่วยความจำของ PlayStation 2ซึ่งมีทั้งข้อความอธิบายรายละเอียดและ 'แผนที่หน่วยความจำ' ที่มีออฟเซ็ตและอื่น ๆ - มันตรงกับกรณีการใช้งานของฉันมากที่สุด มันจะแตกต่างกันเล็กน้อยสำหรับรูปแบบที่แตกต่างกัน แต่ดูเหมือนว่าควรมีหลักการทั่วไปที่ฉันควรลองทำตาม
แก้ไข: ฉันดูเหมือนจะไม่ได้อธิบายอย่างดีว่าฉันต้องการทำอะไร ให้ฉันสร้างตัวอย่าง
ฉันอาจมีบางส่วนของซอฟต์แวร์เก่าที่เก็บการกำหนดค่าไว้ในไฟล์ 'binary' - ชุดของ bitfields, จำนวนเต็ม, สตริง, และอะไรก็ตามทั้งหมดติดกาวเข้าด้วยกันและเข้าใจโดยโปรแกรม แต่ไม่สามารถอ่านได้โดยมนุษย์ ฉันถอดรหัสสิ่งนี้ ฉันต้องการเอกสารว่ารูปแบบของไฟล์นี้ในรูปแบบที่มนุษย์สามารถอ่านได้เป็นข้อมูลจำเพาะสำหรับการนำไลบรารีไปใช้เพื่อวิเคราะห์และแก้ไขไฟล์นี้ นอกจากนี้ฉันต้องการให้คนอื่นเข้าใจได้ง่าย
มีหลายวิธีที่เอกสารดังกล่าวอาจถูกเขียนขึ้น ตัวอย่าง PKZIP ด้านบนนั้นใช้คำมากและส่วนใหญ่จะอธิบายรูปแบบไฟล์เป็นข้อความอิสระ ตัวอย่าง PS2 ให้ตารางประเภทค่าออฟเซ็ตและขนาดพร้อมความคิดเห็นที่ครอบคลุมเกี่ยวกับความหมายทั้งหมด คนอื่น ๆ เช่น XentaxWiki มีเพียงรายการประเภทและขนาดตัวแปรที่มีความเห็นเพียงเล็กน้อยหรือไม่มีเลย
ฉันถามว่ามีมาตรฐานใดบ้างคล้ายกับคู่มือสไตล์การเข้ารหัสซึ่งให้คำแนะนำเกี่ยวกับวิธีเขียนเอกสารประเภทนี้ ถ้าไม่มีตัวอย่างที่ยอดเยี่ยมที่รู้จักกันดีว่าฉันควรเลียนแบบหรือไม่? ถ้าไม่อย่างน้อยใครก็สามารถสรุปคำแนะนำที่เป็นประโยชน์ได้บ้าง
struct
ถ้าผมจำไม่ผิดที่พวกเขาได้รับการบันทึกแฟ้มเป็น มันทำงานได้ค่อนข้างดี