JezK
Edit File: Comments.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". --> <title>Comments (GNU Texinfo 6.8)</title> <meta name="description" content="Comments (GNU Texinfo 6.8)"> <meta name="keywords" content="Comments (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link href="index.html" rel="start" title="Top"> <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Writing-a-Texinfo-File.html" rel="up" title="Writing a Texinfo File"> <link href="Minimum.html" rel="next" title="Minimum"> <link href="Conventions.html" rel="prev" title="Conventions"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="Comments"> <div class="header"> <p> Next: <a href="Minimum.html" accesskey="n" rel="next">What a Texinfo File Must Have</a>, Previous: <a href="Conventions.html" accesskey="p" rel="prev">General Syntactic Conventions</a>, Up: <a href="Writing-a-Texinfo-File.html" accesskey="u" rel="up">Writing a Texinfo File</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> <span id="Comments-1"></span><h3 class="section">2.2 Comments</h3> <span id="index-Comments"></span> <span id="index-comment"></span> <span id="index-c"></span> <p>You can write comments in a Texinfo file by using the <code>@comment</code> command, which may be abbreviated to <code>@c</code>. Such comments are for a person looking at the Texinfo source file. All the text on a line that follows either <code>@comment</code> or <code>@c</code> is a comment; the rest of the line does not appear in the visible output. (To be precise, the character after the <code>@c</code> or <code>@comment</code> must be something other than a dash or alphanumeric, or it will be taken as part of the command.) </p> <p>Often, you can write the <code>@comment</code> or <code>@c</code> in the middle of a line, and only the text that follows after the <code>@comment</code> or <code>@c</code> command does not appear; but some commands, such as <code>@settitle</code>, work on a whole line. You cannot use <code>@comment</code> or <code>@c</code> within a line beginning with such a command. </p> <span id="index-DEL-_0028comment-character_0029"></span> <span id="index-Catcode-for-comments-in-TeX"></span> <p>In cases of nested command invocations, complicated macro definitions, etc., <code>@c</code> and <code>@comment</code> may provoke an error when processing with TeX. Therefore, you can also use the <kbd>DEL</kbd> 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 <kbd>DEL</kbd> will be ignored. </p> <span id="index-Ignored-text"></span> <span id="index-Unprocessed-text"></span> <span id="index-ignore"></span> <p>You can also have long stretches of text ignored by the Texinfo processors with the <code>@ignore</code> and <code>@end ignore</code> 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 <code>@ignore</code> and <code>@end ignore</code> for writing comments. (For some caveats regarding nesting of such commands, see <a href="Conditional-Nesting.html">Conditional Nesting</a>.) </p> </div> <hr> <div class="header"> <p> Next: <a href="Minimum.html">What a Texinfo File Must Have</a>, Previous: <a href="Conventions.html">General Syntactic Conventions</a>, Up: <a href="Writing-a-Texinfo-File.html">Writing a Texinfo File</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> </body> </html>