texinfo: Comments

Overview

Minimum

Conventions

Back to Software Index

1.10 Comments
=============

You can write comments in a Texinfo file by using the '@comment'
command, which may be abbreviated to '@c'.  Such comments are for a
person looking at the Texinfo source file.  All the text on a line that
follows either '@comment' or '@c' is a comment; the rest of the line
does not appear in the visible output.

  Often, you can write the '@comment' or '@c' in the middle of a line,
and only the text that follows after the '@comment' or '@c' command does
not appear; but some commands, such as '@settitle' and '@setfilename',
work on a whole line.  You cannot use '@comment' or '@c' within a line
beginning with such a command.

  In cases of nested command invocations, complicated macro definitions,
etc., '@c' and '@comment' may provoke an error when processing with TeX.
Therefore, you can also use the 'DEL' character (ASCII 127 decimal, 0x7f
hex, 0177 octal) as a true TeX comment character (catcode 14, in TeX
internals).  Everything on the line after the 'DEL' will be ignored.

  You can also have long stretches of text to be ignored by the Texinfo
processors with the '@ignore' and '@end ignore' commands.  Write each of
these commands on a line of its own, starting each command at the
beginning of the line.  Text between these two commands does not appear
in the processed output.  You can use '@ignore' and '@end ignore' for
writing comments.  (For some technical caveats regarding nesting of such
commands, Note: Conditional Nesting.)