XML注释是什么 如何在XML文件中添加说明文字

2次阅读

xml注释语法为,须位于XML声明之后、根元素内部或元素之间,禁止嵌套、禁止含–或结尾前带-,且不能出现在声明前、标签内或非法位置。

XML注释是什么 如何在XML文件中添加说明文字

XML注释的语法格式是什么

XML注释是用 结束的文本块,中间的内容完全被解析器忽略,既不参与结构解析,也不影响文档有效性。

它和 html 注释语法一致,但 XML 规范明确要求:注释不能出现在根元素之前(即 XML 声明之后、根标签之前允许,但声明之前绝对不行),也不能包含 -- 连续字符或结尾的 -,否则会报错 Invalid commentXML parsing Error: comment not terminated

如何在XML中正确插入单行或多行注释

直接在合法位置写 即可。常见安全位置包括:根元素内部任意空白处、元素之间、属性值之外(不能插在开始标签内)。

                 Learning XML     Eric T. Ray      " 必须紧贴,不能有空格   --> 
  • 注释不能嵌套: outer --> 是非法的
  • 注释内可含任意字符(除 -- 和结尾前的 -),包括 >& 等,无需转义
  • 编辑器或解析器通常不保留注释内容,dom 加载后 document.childnodes 中一般看不到它们

哪些地方不能加 XML 注释

看似能放的位置,实际会触发解析失败:

  • XML 声明之前: → 报错 Processing instruction not at start of document
  • 元素开始标签内部:id="1"> → 解析器直接拒绝
  • 注释中间出现 --Invalid comment
  • 注释结尾多空格或换行::纯忽略,无语义,不可被程序读取
  • :内容不被解析(如保留 &),仍属于文档内容树,可被 DOM 读取为文本节点
  • (处理指令):可能被特定处理器识别并执行,比如 XSLT 中的

真正需要让程序读取的说明文字,应该用专门的元素,比如 或带 xml:lang 的元数据字段,而不是依赖注释。

text=ZqhQzanResources