XML 注释可以去任何地方吗？

StackOverflow https://stackoverflow.com/questions/50824

  •  09-06-2019
  •  | 
  •  

题

我编写了一个简单的工具来使用用户输入的查询生成 DBUnit XML 数据集。我想将在 XML 中输入的每个查询作为注释包含在内，但生成 XML 文件的 DBUnit API 不支持在我想要的位置插入注释（在它生成的数据上方），因此我将在顶部或底部对所有查询进行评论。

所以我的问题是：将其放置在任一位置是否有效？例如，上面的 XML 声明：

<!-- Queries used: ... -->
<?xml version='1.0' encoding='UTF-8'?>
<dataset>
  ...
</dataset>

或者在根节点下面：

<?xml version='1.0' encoding='UTF-8'?>
<dataset>
  ...
</dataset>
<!-- Queries used: ... -->

我计划首先尝试上面的 XML 声明，但我怀疑这是否是有效的 XML，尽管来自 维基百科:

注释可以放置在树中的任何位置，如果元素的内容是文本或#PCDATA，则包括文本中。

如果这可行的话我打算发回来，但很高兴知道它是否是官方的 XML 标准。

更新： 看 我的回复如下 对于我的测试结果。

有帮助吗？

解决方案

根据 XML规范, ，一个格式良好的 XML 文档是：

document ::= prolog element Misc*

在哪里 prolog 是

prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

和 Misc 是

Misc ::= Comment | PI | S

和

XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

这意味着，如果您想在顶部添加注释，则不能使用 XML 类型声明。

但是，您可以在声明之后和文档元素外部（文档的顶部或底部）添加注释，因为 Misc* 可以包含评论。

该规范与维基百科的评论一致：

2.5 评论

[定义：注释可以出现在文档中其他标记之外的任何位置；此外，它们还可以出现在文档类型声明中语法允许的位置。它们不是文档字符数据的一部分；XML 处理器可以（但不是必须）使应用程序能够检索注释文本。为了兼容性，字符串“--”（双连字符）不得出现在注释中。] 参数实体引用不得在注释中被识别。

所有这些加在一起意味着您可以发表评论 不在其他标记内的任何地方, ，除了你 如果您以注释开头，则不能有 XML 声明.

然而，虽然理论上理论与实践相符，但实际上却不然，所以我很想知道你的实验效果如何。

其他提示

第一个示例不是有效的 XML，声明必须是 XML 文档中的第一部分。

但除此之外，评论还可以去其他任何地方。

纠正你的第一个例子：

<?xml version="1.0" encoding="UTF-8"?>
<!-- Queries used: ... -->
<dataset>
</dataset>

处理指令必须是 XML 内容中的第一个内容（请参阅 XML注释 和 处理指令）。以下应该有效：

<?xml version='1.0' encoding='UTF-8'?>
<!-- Queries used: ... -->
<dataset>
  ...
</dataset>

谢谢大家的解答！

事实证明，文件前面的注释似乎有效，但当我深入研究 DBUnit 源代码时，这是因为验证已关闭。

我确实尝试通过以下方式进行简单的文档加载：

DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
Document document = builder.parse(new File("/path/to/file"));

这会失败并出现异常，因为 XML 声明不是第一件事（正如其他人指出的那样）。

因此，虽然 DBUnit 可以工作，但我更喜欢拥有有效的 XML，因此我将注释移到了末尾（因为 DBUnit 生成 XML 声明，所以不能选择将注释放置在其下方，尽管我更喜欢这样做。） 。至少事后不修改 XML 是不行的，这将是比其价值更多的工作）。

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top