定義したカスタム ファイル形式から多くの入力を受け取るアプリケーションを開発しています。入力ファイルは、サード パーティによって開発されたアプリケーションによって生成されるため、プログラムへの入力として何が許容され、何が許容されないかを効果的に伝えることができる必要があります。
このファイルには、10 行のヘッダー部分があり、各行は異なるメタ情報を表し、その後に改行と「フッター」が続きます。フッターには情報の中身が含まれています。ヘッダーはかなり単純ですが、フッターになると、各行には事前定義された文字オフセットで始まるいくつかのフィールドがあります。
他の誰かが同様の状況にあり、これらの種類のファイル形式を文書化する方法についてヒントを提供できるかどうか疑問に思っていました. このファイル仕様のドキュメントは Wiki に表示される可能性が最も高いですが、ハードコピーのマニュアルでの公開にも適していると思います。
mouvicielとBravaxからの回答は役に立ちます。1 つは表示に関するもので、もう 1 つはファイル形式についてドキュメントが提供する必要のある技術的な側面です。
私はこの問題の両端にいます（ファイル形式の仕様の作成/使用）。ドキュメントを読んでいたときに欲しかったもののリストを次に示します。
技術的な面では、後で追加できるようにファイル形式に柔軟性を持たせます。ヘッダーを持つことは素晴らしいアイデアです。将来、他のメタ属性を追加する必要がある場合に備えて、「ヘッダーの長さ」属性とともにバージョン番号ヘッダー行を作成することもできます!
質問の2番目の段落は、インターフェイスドキュメントの良い紹介になります。
次に、2つのセクションを追加します。1つはヘッダー用、もう1つはフッター用です。
ヘッダーセクションには、各行で期待される内容の説明が含まれています。
Foorterセクションは、各行が1つのフィールドを記述し、列が次のテーブルです。
私は過去に、これにほぼ類似したXMLスキーマの作成を支援しました。
私のアドバイスは、ファイルがどのように構築されているかを正確に文書化する際に絶対的に明示することです。したがって、あいまいさはありません。
したがって、考慮する必要があることは次のとおりです。
理想的には、ファイルを検証するために、サードパーティに提供するバリデータープログラムを作成できます。したがって、何かがうまくいかない可能性を最小限に抑えます。