XMLWriter::writeComment()函数—用法及示例

函数名称：XMLWriter::writeComment()

适用版本：PHP 5 >= 5.1.2, PHP 7

函数描述：该函数用于在XMLWriter对象中写入注释。

语法：XMLWriter::writeComment(string $content) : bool

参数：

• $content: 必需，表示要写入的注释内容。

返回值：成功时返回true，失败时返回false。

示例：

// 创建XMLWriter对象
$writer = new XMLWriter();

// 打开文件并启用缓冲
$writer->openUri('example.xml');
$writer->startDocument('1.0', 'UTF-8');
$writer->setIndent(true);

// 写入注释
$writer->writeComment('This is a comment.');

// 写入元素
$writer->startElement('root');
$writer->writeElement('child', 'Value');
$writer->endElement();

// 结束写入并保存文件
$writer->endDocument();
$writer->flush();

// 输出生成的XML内容
echo file_get_contents('example.xml');

输出结果：

<?xml version="1.0" encoding="UTF-8"?>
<!--This is a comment.-->
<root>
    <child>Value</child>
</root>

在上面的示例中，我们首先创建了一个XMLWriter对象，并打开了一个XML文件。然后，我们使用writeComment()函数写入了一个注释，并使用startElement()和writeElement()函数写入了一个简单的XML元素。最后，我们使用endDocument()和flush()函数结束写入并保存了文件。最后，我们使用file_get_contents()函数读取生成的XML文件内容，并将其输出到浏览器上。