DOMDocument::createComment()函数—用法及示例

函数名：DOMDocument::createComment()

适用版本：PHP 5, PHP 7

用法：DOMDocument::createComment() 方法用于创建一个注释节点。

语法：DOMComment DOMDocument::createComment( string $data )

参数：

• $data：注释内容。

返回值：返回一个 DOMComment 对象，表示创建的注释节点。

示例：

<?php
// 创建一个新的 DOMDocument 对象
$dom = new DOMDocument();

// 创建一个注释节点
$comment = $dom->createComment('这是一个注释');

// 将注释节点添加到文档中
$dom->appendChild($comment);

// 输出生成的 XML
echo $dom->saveXML();
?>

输出结果：

<?xml version="1.0"?>
<!--这是一个注释-->

注意事项：

• 注释节点不会影响 XML 的结构和语义，它仅用于添加对 XML 的解释或说明。
• $data 参数是注释节点的内容，可以是任意字符串。在输出的 XML 中，注释将以 <!-- 开始，以 --> 结束。
• 创建的注释节点需要通过调用 DOMDocument 对象的 appendChild() 或其他相关方法将其添加到文档中才能生效。
• 如果要创建注释节点，并将其添加到具体的元素节点中，可以使用元素节点的 appendChild() 方法。