PHP - xmlwriter_write_comment() 函数

定义和用法

XML 是一种用于在网络上共享数据的标记语言，XML 既可供人类阅读，也可供机器阅读。XMLWriter 扩展内部具有 libxml xmlWriter API，用于写入/创建 XML 文档的内容。由此生成的 XML 文档是非缓存的且仅向前。

xmlwriter_write_comment() 函数接受 XMLWriter 类的对象和表示注释内容的字符串值，并创建完整的注释标签。

语法

xmlwriter_start_comment($writer);

参数

返回值

此函数返回一个布尔值，成功时为 TRUE，失败时为 FALSE。

PHP 版本

此函数首次引入于 PHP 5 版本，并在所有后续版本中有效。

示例

以下示例演示了 xmlwriter_write_comment() 函数的用法 -

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();

   //Opening a writer
   $uri = "result.xml";
   $writer = xmlwriter_open_uri($uri);

   //Starting the document
   xmlwriter_start_document($writer);

   //Starting an element
   xmlwriter_start_element($writer, 'Msg');
    
   //Creating a comment tag
   xmlwriter_write_comment($writer, 'This is a sample comment' );

   //Adding text to the element
   xmlwriter_text($writer, 'Welcome to Tutorialspoint');  

   //Starting an element
   xmlwriter_end_element($writer);

   //Ending the document
   xmlwriter_end_document($writer);
?>

这将生成以下 XML 文档 -

<?xml version="1.0"?>
<Msg><!--This is a sample comment-->Welcome to Tutorialspoint</Msg>

示例

以下是在面向对象风格中使用此函数的示例 -

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();

   //Opening a writer
   $uri = "result.xml";
   $writer->openUri($uri);

   //Starting the document
   $writer->startDocument();

   //Starting an element
   $writer->startElement('Msg');

   //Creating the comment tag 
   $writer->writeComment('This is a sample comment'); 

   //Adding text to the element
   $writer->text('Welcome to Tutorialspoint');  

   //Ending the element
   $writer->endElement();

   //Ending the document
   $writer->endDocument();
?>

这将生成以下 XML 文档 -

<?xml version="1.0"?>
<Msg><!--This is a sample comment-->Welcome to Tutorialspoint</Msg>