Xport Interface: comment overview

Xport's comment type alias, (and other aliases typed from xhtml_comment), encapsulates an xhtml comment.

Like element, pcdata, and procinstr, comment is derived from markup. Although it's possible to call many of markup's operations on a comment object, most of those operations in markup apply only to element, and calling them on comment will not perform any action.

comments's constructor allows you to specify the comment's text content. More text can be added to the comment object using comment's << operation.

The type alias that you use for your comment depends on two factors. The document type you wish to use, and the character type you wish to use. The list below reveals the available type aliases for Xport's comment.

xhtml_comment's type aliases.

• comment - xhtml strict, narrow character (default).
• wcomment - xhtml strict, wide character
• tcomment - xhtml transitional, narrow character
• wtcomment - xhtml transitional, wide character
• fcomment - xhtml frameset, narrow character
• wfcomment - xhtml frameset, wide character

There are only a few operations that are relevant to call on comment, which are listed below.

• comment()
• insertion operator (<<)
• markup_type()
• parent()
• write()