XML评论可以随处发生吗？

Question

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

所以我的问题是：将它放在任何一个位置都是有效的XML吗？例如，在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，尽管wikipedia声称：

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

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

更新：请参阅my response below了解我的测试结果。

Answer 1

根据XML specification，一个格式良好的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声明。

然而，虽然在理论上理论同意实践，但在实践中却没有，所以我很想知道你的实验是如何运作的。

Answer 2

第一个例子不是有效的XML，声明必须是XML文档中的第一件事。

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

纠正你的第一个例子：

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

Answer 3

处理指令必须是XML内容中的第一件事（参见XML comment和processing instructions）。以下应该有效：

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

Answer 4

谢谢大家的答案！

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

我确实尝试过一个简单的文档加载：

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

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

因此，虽然DBUnit可以工作，但我更喜欢使用有效的XML，所以我将注释移到了最后（因为DBUnit生成了XML声明，因此不能将注释放在它下面，即使我更喜欢它...至少在事后没有修改XML的情况下，这将是更多的工作而不是它的价值。