PHP | XMLWriter startComment() Function

The XMLWriter::startComment() function is an inbuilt function in PHP which is used to start comment. This comment later needs to be closed using XMLWriter::endComment() function.

Syntax:

bool XMLWriter::startComment( void )

Parameters:This function doesn’t accept any parameter.



Return Value: This function returns TRUE on success or FALSE on failure.

Below examples illustrate the XMLWriter::startComment() function in PHP:

Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// Create a new XMLWriter instance
$writer = new XMLWriter();
  
// Create the output stream as PHP
$writer->openURI('php://output');
  
// Start the document
$writer->startDocument('1.0', 'UTF-8');
  
// Start a element
$writer->startElement('div');
  
// Start a comment
$writer->startComment();
  
// Add text to the comment
$writer->text('This is a comment');
  
// End the comment
$writer->endComment();
  
// End the element
$writer->endElement();
  
// End the document
$writer->endDocument();
?>

chevron_right


Output:

<?xml version="1.0" encoding="UTF-8"?>
<div><!--This is a comment--></div>

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// Create a new XMLWriter instance
$writer = new XMLWriter();
  
// Create the output stream as PHP
$writer->openURI('php://output');
  
// Start the document
$writer->startDocument('1.0', 'UTF-8');
  
// Start a element
$writer->startElement('div');
  
// Start a comment
$writer->startComment();
  
// Add text to the comment which will not be visible
$writer->text('This will not be visible.');
  
// End the comment
$writer->endComment();
  
// Add value to the element
$writer->text('This is the visible text.');
  
// End the element
$writer->endElement();
  
// End the document
$writer->endDocument();
?>

chevron_right


Output:

<?xml version="1.0" encoding="UTF-8"?>
<div><!--This will not be visible.-->
This is the visible text.</div>

Reference: https://www.php.net/manual/en/function.xmlwriter-start-comment.php




My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.


Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.