This will write a XML <!----> style comment to your XMLWriter resource.
Strings up to 50 characters long are displayed on a single line with no spacing between the tags.
Anything above 50 characters will show on multiple formatted lines. Using the \n metacharater inserts a newline and maintains indenting.
XMLWriter::writeComment
xmlwriter_write_comment
(PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0)
XMLWriter::writeComment -- xmlwriter_write_comment — Write full comment tag
Description
Object oriented style
XMLWriter::writeComment
( string
$content
) : boolProcedural style
xmlwriter_write_comment
( resource
$xmlwriter
, string $content
) : boolWrites a full comment.
Parameters
-
xmlwriter -
Only for procedural calls. The XMLWriter resource that is being modified. This resource comes from a call to xmlwriter_open_uri() or xmlwriter_open_memory().
-
content -
The contents of the comment.
Return Values
Returns TRUE on success or FALSE on failure.
See Also
- XMLWriter::startComment() - Create start comment
- XMLWriter::endComment() - Create end comment
add a note
User Contributed Notes 1 note
thewrs at gmail dot com ¶
16 years ago
