Including Writer's Comments

Frequently it is useful to include within your source files comments that are not intended to be part of the help text. Text marked with the Comment element is always ignored by the DocBook software. Comments can be used to make notes to yourself or to another author, or to exclude some markup without taking it out of the file.

A Comment may appear almost anywhere in the document, and may contain paragraphs and other block-oriented elements, but a Comment cannot be nested within another Comment.

Syntax

<comment> comment text here </comment>

To Insert a Comment

Use the comment begin marker <Comment> and end marker </Comment> as shown:

<comment> comment text here </comment>

Example

Here's an example that has two comments, a line before the paragraph, and a single word within the paragraph.

<Comment>Here is my rough draft of the introduction: </Comment> Welcome to my application. This software is <Comment>perhaps</Comment>the fastest and most efficient software you'll ever own.