Як документувати специфікацію формату файлу [закрито]

Для проекту мені потрібно працювати з різними типами файлів деяких старих ігор та відповідного програмного забезпечення - файли конфігурації, збереження, архіви ресурсів тощо. Більшість з них ще не задокументовані, а також не існує інструментів для роботи з ними, тому я повинен інженерно розробити формати та створити власні бібліотеки для їх обробки.

Хоча я не думаю, що на більшу частину цього попиту є великий попит, я маю намір опублікувати результати своїх зусиль. Чи є прийняті стандарти документування форматів файлів? Оглянувшись, використовується декілька стилів: деякі, як-от специфікація формату файлу .ZIP , дуже виразні; інші, як, наприклад, на XentaxWiki, набагато більш стислі - мені деякі з них важко читати; той, який мені особисто найбільше подобається, - це опис файлової системи пам'яті PlayStation 2 , що включає в себе як детальний описовий текст, так і декілька «карт пам'яті» із зрушеннями і таке - воно також найбільш відповідає моєму використанню. Це буде трохи відрізнятися для різних форматів, але, схоже, повинні бути деякі загальні принципи, яких я повинен намагатися дотримуватися.

Редагувати: Я, здається, не дуже добре пояснив, що хочу зробити. Дозвольте побудувати приклад.

У мене може бути якийсь старий фрагмент програмного забезпечення, який зберігає його конфігурацію у «двійковому» файлі - це ряд біт-полів, цілих чисел, рядків і того, що все не склеєне і зрозуміле програмою, але не читабельне для людини. Я розшифровую це. Я хочу задокументувати, який саме формат цього файлу, легко читається як специфікацію для впровадження бібліотеки для розбору та зміни цього файлу. Крім того, я хотів би, щоб це легко зрозуміли інші люди.

Існує кілька способів написання такого документа. Наведений вище приклад PKZIP є дуже багатомовним і в основному описує формат файлу у вільному тексті. У прикладі PS2 наведено таблиці типів значень, компенсацій та розмірів із широкими коментарями до того, що вони означають. Багато інших, як, наприклад, на XentaxWiki, лише перелічують типи та розміри змінних, мало коментарів або взагалі не мають.

Я запитую, чи є якийсь стандартний, подібний до посібника зі стилю кодування, який дає вказівки щодо написання такого роду документації. Якщо ні, чи є відомий чудовий приклад, який я повинен наслідувати? Якщо ні, чи може хтось хоча б узагальнити якусь корисну пораду?

Бінарний файл - це лише послідовність бітів, розташованих у логічні одиниці за певними правилами . Ці правила зазвичай називають граматикою . Граматика можна розділити на чотири типи ( ієрархії Хомського ), і для контекстно-вільних граматик ви повинні використовувати розширений Бекуса-Наура як зазначив Метт Фенвік в своєму коментарі. Інтерпретація (або семантика) послідовності, що зберігається у файлі, може бути описана усно чи за допомогою анотованих зразків програм, серіалізуючи та десеріалізуючи інформацію.

Щоб дізнатися більше про документування бінарних форматів файлів, запропонуйте прочитати, наприклад, стандарт ASN.1 .

Це дивно, тому що швидкий пошук форматів файлів вивів статтю у Вікіпедії (Список форматів файлів) . Вона також включає декілька форматів даних відеоігор .

Список загальних форматів файлів даних для відеоігор у системах, що підтримують файлові системи, найчастіше на ПК.

Він також включає великий вибір форматів носіїв для зберігання відеоігор .

Список найпоширеніших розширень назви файлів, які використовуються, коли зображення ROM чи носій пам’яті гри копіюється з оригінального пристрою ПЗУ на зовнішню пам’ять, наприклад, на жорсткий диск для цілей резервного копіювання або для того, щоб гра була відтворена емулятором. У випадку з програмним забезпеченням на базі картриджів, якщо розширення для певної платформи не використовується, тоді розширення назви файлів ".rom" або ".bin" зазвичай використовуються для уточнення, що файл містить копію вмісту ПЗУ. Зображення ПЗУ, диска чи стрічки зазвичай не складаються з одного файлу чи ПЗУ, а всього цілого файлу або структури ПЗУ, що містяться в одному файлі на резервному носії.

Чи є прийняті стандарти документування форматів файлів?

"Офіційного" стандарту ніде немає. Оскільки формати файлів виготовлені компанією, компанія приймає рішення про формат документації.