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:
<?php // Create a new XMLWriter instance $writer = new XMLWriter();
// Create the output stream as PHP // 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();
?> |
Output:
<?xml version="1.0" encoding="UTF-8"?> <div><!--This is a comment--></div>
Program 2:
<?php // Create a new XMLWriter instance $writer = new XMLWriter();
// Create the output stream as PHP // 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();
?> |
Output:
<?xml version="1.0" encoding="UTF-8"?> <div><!--This will not be visible.--> This is the visible text.</div>