File 记录文件格式

我们正在开发一个应用程序，它接收来自我们定义的自定义文件格式的大量输入。输入文件是由第三方开发的应用程序生成的，因此我们自然需要能够有效地将哪些是和哪些是不可接受的输入传达到我们的程序中

该文件的页眉部分有10行，每行代表一条不同的元信息，后跟一个换行符和“页脚”。页脚包含信息的核心。页眉相当直接，但当我们谈到页脚时，每行都有几个字段，这些字段以预定义的字符偏移量开始

---

我想知道是否有其他人也遇到过类似的情况，可以提供一些提示，说明如何记录这些类型的文件格式。此文件规范的文档很可能会显示在Wiki上，但我也希望它适合在硬拷贝手册中发布。

问题的第二段将是对界面文档的良好介绍

然后我将添加两个部分，一个用于页眉，另一个用于页脚

标题部分包含对每行的预期内容的描述

foorter部分是一个表，其中每行描述一个字段，列为：

• 字段名
• 抵消
• 长度
• 目的

---

我过去曾帮助编写过一个与此大致相似的XML模式

我的建议是绝对明确地记录文件是如何构造的，因此不存在歧义

所以你需要考虑的事情是：

• 间距
• 行尾标记
• 文件结束标记
• 文件每个区域中允许的字符
• 每个区域中允许的值范围
• 所需的任何编码，以及使用何种方法/算法

理想情况下，您可以编写一个验证程序，将其提供给第三方，以验证文件。从而最大限度地减少出错的可能性。

和的答案很有帮助。一个涉及显示，另一个涉及文档应提供的有关文件格式的一些技术方面

我一直处于这个问题的两端（创建/使用文件格式规范）。这是我在阅读文档时希望拥有的东西的列表

• 有视觉表现的 文件格式
• 有一个文件格式的例子。 包括 文档创建者可能会认为 合法但不合法也将是合法的 有帮助
• 如果您的文档是电子文档， 将其超链接到相关的 零件是有用的
• 提供理由证明 文件格式。这有助于人们理解他们为什么要做某事，而不是盲目地遵循规范

在技术方面，为以后的添加在文件格式中创造灵活性。头球是个好主意。我甚至会创建一个版本号标题行以及一个“标题长度”属性，这样，如果您将来需要添加其他元属性，您就可以