| <!DOCTYPE html> |
| <html> |
| <!-- Created by Texinfo 6.8dev+dev, http://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.8dev, 23 February 2022), |
| 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-2022 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.8dev)</title> |
| |
| <meta name="description" content="Comments (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="Comments (GNU Texinfo 6.8dev)"> |
| <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"> |
| <!-- |
| kbd.kbd {font-style: oblique} |
| span.r {font-family: initial; font-weight: normal} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="Comments"> |
| <div class="nav-panel"> |
| <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> |
| <h3 class="section" id="Comments-1">2.2 Comments</h3> |
| |
| <a class="index-entry-id" id="index-Comments"></a> |
| <a class="index-entry-id" id="index-comment"></a> |
| <a class="index-entry-id" id="index-c"></a> |
| |
| <p>You can write comments in a Texinfo file by using the <code class="code">@comment</code> |
| command, which may be abbreviated to <code class="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 class="code">@comment</code> or <code class="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 class="code">@c</code> or <code class="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 class="code">@comment</code> or <code class="code">@c</code> in the middle |
| of a line, and only the text that follows after the <code class="code">@comment</code> |
| or <code class="code">@c</code> command does not appear; but some commands, such as |
| <code class="code">@settitle</code>, work on a whole line. You cannot use <code class="code">@comment</code> |
| or <code class="code">@c</code> within a line beginning with such a command. |
| </p> |
| <a class="index-entry-id" id="index-DEL-_0028comment-character_0029"></a> |
| <a class="index-entry-id" id="index-Catcode-for-comments-in-TeX"></a> |
| <p>In cases of nested command invocations, complicated macro definitions, |
| etc., <code class="code">@c</code> and <code class="code">@comment</code> may provoke an error when |
| processing with TeX. Therefore, you can also use the <kbd class="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 class="kbd">DEL</kbd> will be ignored. |
| </p> |
| <a class="index-entry-id" id="index-Ignored-text"></a> |
| <a class="index-entry-id" id="index-Unprocessed-text"></a> |
| <a class="index-entry-id" id="index-ignore"></a> |
| <p>You can also have long stretches of text ignored by the Texinfo |
| processors with the <code class="code">@ignore</code> and <code class="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 class="code">@ignore</code> |
| and <code class="code">@end ignore</code> for writing comments. (For some caveats |
| regarding nesting of such commands, see <a class="pxref" href="Conditional-Nesting.html">Conditional Nesting</a>.) |
| </p> |
| |
| </div> |
| <hr> |
| <div class="nav-panel"> |
| <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> |
