XML注释合法位置仅限根元素外层之间，不可在声明后、标签内；Python标准库需ET.Comment()（3.9+）插入，Java须用Document.createComment()；手动拼接易因未转义“--”致解析失败。
XML里加注释的合法位置在哪
注释只能出现在根元素内外层之间，不能插在元素开始标签、结束标签内部，也不能放在<?xml ?>声明之后、根元素之前（虽然部分解析器容忍，但不符合XML规范）。最安全的位置是：根元素开头前、结尾后，或同级兄弟节点之间。
Python用xml.etree.ElementTree插入Comment节点
ElementTree本身不提供直接创建注释的API，必须用etree.Comment()（来自lxml）或手动构造Comment对象（标准库需绕行）。标准库xml.etree.ElementTree的正确做法是：
- 用
ET.Comment("your note")创建注释节点（Python 3.9+ 支持；旧版本会报AttributeError） - 插入时用
parent.insert(index, comment)或parent.append(comment)，不能用subelement - 注释节点没有
tag，打印时显示为<!-- your note -->，但type(comment)是xml.etree.ElementTree.Comment
示例：
import xml.etree.ElementTree as ET
root = ET.Element("root")
comment = ET.Comment("Generated by script")
root.append(comment) # ✅ 正确
ET.dump(root)输出：<root><!-- Generated by script --></root>
Java中用DocumentBuilder添加Comment节点
Java的org.w3c.dom.Document接口有明确的createComment()方法，但必须通过Document实例调用，不能用Element。常见错误是试图在Element上调用它，导致NullPointerException或编译失败。
- 先用
document.createComment("text")生成Comment节点 - 再用
parent.appendChild(comment)或parent.insertBefore(comment, refNode)插入 - 注意：
Comment是Node子类，不是Element，所以不能设属性、不能有子节点 - 如果用
Transformer输出，需确保OutputKeys.INDENT设为"yes"，否则注释可能被挤在一行末尾难识别
写入后注释消失或格式错乱的原因
不是代码没生效，而是解析/写入环节丢弃了注释。常见于：
- 用
minidom时未设置dom.writexml(..., encoding="utf-8", newl="\n", indent=" ")，默认不保留空白和注释结构 - 用
lxml.etree.parse()加载时，默认remove_comments=False，但如果后续用deepcopy或XSLT处理，可能过滤掉Comment节点 - 某些XML Schema验证器（如Xerces）在
validation模式下会跳过注释，导致写回时丢失 - 手动生成字符串拼接
"
