记录文件格式

Question

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

该文件的标题部分为10行，每行代表一条不同的元信息，后跟换行符和“页脚”。页脚包含信息的内容。标题非常简单，但是当我们来到页脚时，每行都有几个以预定义字符偏移量开始的字段。

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

Answer 1

mouviciel和Bravax的答案很有帮助。一个处理显示另一个与文档应提供的有关您的文件格式的一些技术方面。

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

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

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

Answer 2

您问题的第二段将是对您的界面文档的一个很好的介绍。

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

标题部分包含每行预期内容的说明。

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

• 字段名称，
• 偏移，
• 长度，
• 目的

Answer 3

我过去帮助编写了一个XML Schema，与此类似。

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

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

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

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