PHP中通过DOMDocument的createComment()和appendChild()插入XML注释，注释节点可插入文档或元素内，但XPath需显式指定comment()轴才能匹配，SimpleXML默认丢弃注释，且注释会影响formatOutput缩进。

PHP中怎么给XML加注释

PHP本身不提供直接“向XML文档插入注释”的专用函数，但可以通过 DOMDocument 的 createComment() + appendChild() 组合完成。关键不是“怎么写注释语法”，而是“在哪插、用什么节点类型、是否影响解析”。

• createComment() 返回一个 DOMComment 节点，它和 DOMElement 是同级节点类型，可被插入到任意支持子节点的父节点中（如 DOMDocument 或 DOMElement）
• 注释内容不能包含 --（XML规范禁止），否则 saveXML() 会报错或截断
• 如果插入到根元素外（即作为 DOMDocument 的子节点），注释会出现在 XML 声明之后、根标签之前；插入到某元素内，则出现在该元素的起始/结束标签之间

$doc = new DOMDocument();
$doc->loadXML('data');
$comment = $doc->createComment('Generated by PHP on ' . date('Y-m-d'));
// 插入到根元素前（即文档级注释）
$doc->insertBefore($comment, $doc->documentElement);
echo $doc->saveXML();

DOMComment节点能被XPath匹配吗

不能。XPath 1.0（PHP DOMXPath 默认实现）不支持 comment() 轴在默认上下文中命中注释节点——除非你显式指定轴。常见误区是写 //comment() 却没结果，其实是因为没选对上下文节点。

• 必须用 /*//comment() 或 /comment() | //comment() 才可能匹配到（取决于你想查哪一层）
• 更可靠的做法是先用 $doc->childNodes 遍历，再用 instanceof DOMComment 判断
• DOMXPath::query() 对注释节点的返回结果是 DOMNodeList，但每个项是 DOMComment，可安全调用 $node->textContent

$xpath = new DOMXPath($doc);
$comments = $xpath->query('//comment()'); // 注意：这只会匹配元素内部的注释
foreach ($comments as $c) {
    echo "Found comment: " . $c->textContent . "\n";
}

SimpleXML能处理XML注释吗

不能原生支持。SimpleXML 在加载时默认丢弃所有注释节点（除非显式启用 SIMPLEXML_LOAD_STRING 的 LIBXML_NOBLANKS | LIBXML_NONET 以外的选项），且没有暴露注释操作接口。

• 若需保留注释，必须用 libxml_use_internal_errors(true) + libxml_get_errors() 检查警告，但依然无法读取
• 唯一可行路径：用 DOMDocument 加载并保留注释（默认就保留），再用 dom_import_simplexml() 双向桥接——但注释节点不会出现在 SimpleXML 对象的属性或方法中
• 别试图用 simplexml_load_string() 后再转 DOM：注释早已丢失，转过去也空

XML注释会影响DOMDocument::saveXML()输出格式吗

会，但只在“空白敏感”场景下。PHP 的 DOMDocument 默认不自动缩进，所以注释本身不会导致换行或缩进；但如果你启用了 $doc->formatOutput = true，注释节点会被当作普通子节点参与缩进计算，可能造成意外空行。

• 注释节点在 childNodes 中占位，formatOutput 会对它前后加换行+缩进
• 若想避免，可在保存前临时移除注释：$doc->removeChild($comment)，用完再加回去
• 注意：saveXML(

  

  ) 输出的注释内容不会被转义（如 不变），但若内容含非法字符（如 --），会直接抛出 Warning 并中断输出

真正容易被忽略的是：XML 注释不是元数据容器，它不参与 schema 验证、XSLT 变换默认也不处理它——除非你主动用 xsl:comment 或 comment() 轴提取。把它当调试标记用可以，当配置载体用就踩坑了。