PHP xmlwriter_write_comment()用法及代码示例

定义和用法

XML 是一种 mark-up 语言，用于在网络上共享数据，XML 用于人类 read-able 和机器 read-able。 XMLWriter 扩展内部具有 libxml xmlWriter API，用于编写/创建 XML 文档的内容。由此生成的 XML 文档是非缓存的和 forward-only。

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

用法

xmlwriter_start_comment($writer);

参数

Sr.No	参数及说明
1	writer(Mandatory) 这是 XMLWriter 类的一个对象，表示您要修改/创建的 XML 文档。
2	comment(Mandatory) 这是一个表示注释内容的字符串值。

返回值

此函数返回一个布尔值，成功时为 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>