Comment commenter une partie d'un fichier source LaTeX? [FAQ LaTeX]

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
====== Comment commenter une partie d'un fichier source LaTeX? ======

===== Avec le caractère % =====

Tout ce qui se trouve entre le caractère ''%'' et la fin de la ligne (inclus tous les deux) est ignoré dans le résultat produit par <latex>\TeX</latex> et <latex>\LaTeX</latex>.

<WRAP column 40ex>
<code latex>
Que va-t-on % vraiment
voir dans le document produit ?
</code>
</WRAP>
<WRAP column 30ex>
<latex>
Que va-t-on % vraiment
voir dans le document produit ?
</latex>
</WRAP>
<WRAP clear />

Bon nombre d'éditeurs offrent la possibilité de commenter des passages.
Par exemple, "(un)comment-region" avec ''Emacs''.

<note warning>
Si vous copiez-collez du texte depuis un document non-LaTeX, vérifiez que le signe ''%'' n'est pas utilisé,
sinon une partie du contenu pourrait disparaître silencieusement:

<WRAP clear />
<WRAP column 56ex>
<code>
Cher Jacques,

Je suis 100 % d'accord avec vous. Mais il faudra
mettre devant...
</code>
</WRAP>
<WRAP column 30ex>
<latex>
Cher Jacques,

Je suis 100 % d'accord avec vous. Mais il faudra
mettre devant...
</latex>
</WRAP>
<WRAP clear />

Pour retrouver le texte original, vous devrez protéger le signe ''%'' avec une barre oblique inversée:
<WRAP clear />
<WRAP column 56ex>
<code latex>
Cher Jacques,

Je suis 100 \% d'accord avec vous. Mais il faudra
mettre devant...
</code>
</WRAP>
<WRAP clear />
</note>

===== Avec un environnement “comment” =====

Plusieurs extensions définissent un environnement ''comment'': [[ctanpkg>comment]],
[[ctanpkg>verbatim]] et [[ctanpkg>version]].
Par exemple :

<WRAP column 50ex>
<code latex>
\documentclass{article}
  \usepackage{comment}

\begin{document}

\begin{comment}
Comme ce texte se trouve dans 
l'environnement \texttt{comment},
il ne reste
\end{comment}
rien !

\end{document}
</code>
</WRAP>
<WRAP column 10ex>
<latexdoc>
\documentclass{article}
  \usepackage{comment}
  \pagestyle{empty}

\begin{document}
\begin{comment}
Comme ce texte ce trouve dans 
l'environnement \texttt{comment},
il ne reste
\end{comment}
rien !
\end{document}
</latexdoc>
</WRAP>
<WRAP clear />

<note important>
Il existe aussi le package [[ctanpkg>optional]], qui permet de faire apparaître ou non du texte
en fonction d'options passées au package. Malheureusement, il n'est pas très robuste,
notamment il ne fonctionne pas avec du contenu ''verbatim''.

Il est donc déconseillé de s'en servir pour mettre de contenu en commentaire.
</note>

===== Avec une évaluation conditionnelle =====

Classique et de bon goût, l'évaluation conditionnelle permet de mettre en commentaire sans se soucier de l'imbrication des accolades. Elle est cependant moins puissante que les extensions qui créent un environnement dédié pour les commentaires.

Pour effectuer une évaluation conditionnelle, on peut utiliser l'extension [[ctanpkg>ifthen|ifthen]] sous <latex>\LaTeX</latex> et la commande ''\iffalse'' avec Plain <latex>\TeX</latex>.

Exemple en Plain <latex>\TeX</latex>:

<WRAP column 50ex>
<code latex>
\iffalse
Ceci est en commentaire sous Plain \TeX{}.
\fi
</code>
</WRAP>
<WRAP clear />

Exemple en <latex>\LaTeX</latex>:

<WRAP column 50ex>
<code latex>
\usepackage{ifthen}

Regardez comme c'est simple
\ifthenelse{\boolean{false}}
{Ne pas oublier le \usepackage{ifthen}
pour cette commande sous \LaTeX{}}{}%
de faire disparaître du texte!
</code>
</WRAP>
<WRAP column 30ex>
<latexdoc>
\documentclass{article}
  \usepackage{ifthen}
  \pagestyle{empty}

\begin{document}
Regardez comme c'est simple
\ifthenelse{\boolean{false}}
{Ne pas oublier le \usepackage{ifthen}
pour cette commande sous \LaTeX{}}{}%
de faire disparaître du texte!
\end{document}
</latexdoc>
</WRAP>
<WRAP clear />

<note important>
Dans ce dernier exemple, faites bien attention à utiliser le ''%'' pour
mettre en commentaire la fin de ligne après ''\ifthenelse''.
Si vous l'oubliez, vous aurez une espace en trop dans le rendu final,
entre «<latex>simple</latex>» et «<latex>de faire</latex>»:
<WRAP clear />

<WRAP column 45ex>
<code latex>
\usepackage{ifthen}

Regardez comme c'est simple
\ifthenelse{\boolean{false}}
{Ne pas oublier le \usepackage{ifthen}
pour cette commande sous \LaTeX{}}{}
de faire disparaître du texte!
</code>
</WRAP>
<WRAP column 30ex>
<latexdoc>
\documentclass{article}
  \usepackage{ifthen}
  \pagestyle{empty}

\begin{document}
Regardez comme c'est simple
\ifthenelse{\boolean{false}}
{Ne pas oublier le \usepackage{ifthen}
pour cette commande sous \LaTeX{}}{}
de faire disparaître du texte!
\end{document}
</latexdoc>
</WRAP>
<WRAP clear />
</note>

{{htmlmetatags>metatag-keywords=(LaTeX,commentaire,cacher du texte,inclure des commentaires,annoter un document LaTeX)
metatag-og:title=(Commenter une partie d'un fichier source LaTeX)
metatag-og:site_name=(FAQ LaTeX francophone)
}}