Auskommentieren von großen Abschnitten


Die Kommentarfunktion im Standard von LaTeX ist nur für einzelne Zeilen geeignet, für die Verwendung bei ganzen Absätzen oder noch längeren Abschnitten sollte anstelle des Prozentzeichens (%) die comment Umgebung verwendet werden. Dazu ist die Einbindung eines zusätzlichen Paketes notwendig. Interessanterweise gibt es zwei Pakete, die die comment Umgebung zur Verfügung stellen, zum einen ist da das verbatim Paket und zu anderen das comment Paket.

verbatim

Das verbatim Paket beinhaltet neben anderen Umgebung auch die comment Umgebung.

\documentclass[margin=10pt]{standalone}
%...
\usepackage{verbatim}
%...
\begin{document}
%...
This text will be showed and part of the document\par
\begin{comment}
    This text will not be showed and 
    will be not part of the document  
\end{comment}
%...
more stuff 
\end{document}

comment

Das comment Paket beinhaltet ebenfalls eine comment Umgebung.

\documentclass[margin=10pt]{standalone}
%...
\usepackage{comment}
%...
\begin{document}
%...
This text will be showed and part of the document\par
\begin{comment}
    This text will not be showed and 
    will be not part of the document  
\end{comment}
%...
more stuff 
\end{document}

Zwei Paket ein Problem

Es gibt zum einen den Hinweis, dass es bei der Verwendung der verbatim Variante innerhalb von manchen Umgebungen zu Problemen kommen kann. So wird in der bekannten LaTeX Einführung „The Not So Short Introduction to LaTeX2e“ auf Seite 6 Abschnitt 1.3.4 Comments (siehe hier)folgender Hinweis zur Verwendung der comment Umgebung aus dem verbatim gegeben: „Note that this won’t work inside complex environments, like math for example.“ auf Deutsch „Beachten Sie, dass dies [d.h. die comment Umgebung] in komplexen Umgebungen, wie zum Beispiel in der Mathematik, nicht funktioniert.“

Die zwei nachfolgenden Beispiel zeigen, wie die comment Umgebung sowohl aus dem verbatim als auch aus dem comment Paket innerhalb von Mathematik verwendet wurden. Möglicherweise ist dieses Beispiel jedoch nicht komplex genug, um ein entsprechendes Fehlverhalten zu provozieren.

\documentclass[margin=10pt]{standalone}
%...
\usepackage{verbatim}
%...
\begin{document}
%...
\(
\sqrt{a^{2} + b^{2}} = c 
\begin{comment} 
is a famous equation 
\end{comment}
\quad c = c 
\) 
%...
\end{document}
\documentclass[margin=10pt]{standalone}
%...
\usepackage{comment}
%...
\begin{document}
%...
\(
\sqrt{a^{2} + b^{2}} = c 
\begin{comment} 
is a famous equation 
\end{comment}
\quad c = c 
\) 
%...
\end{document}

Ein anderer Grund für das zweite Paket könnte sein, dass sich das comment Paket, hauptsächlich, wenn nicht gar ausschließlich, mit dem Auskommentieren beschäftigt, während dies beim verbatim Paket nur einer der Bestandteile ist.


Kommentare sind geschlossen.