☰

如何在 LaTeX 文件中写入隐藏注释？

tag-icon • tag-icon comments text-manipulation
如何在 LaTeX 文件中写入隐藏注释？

如何在 LaTeX 文件中书写未出现在 PDF 文件中的注释？

答案1

较小的文本可以用字符标记为注释%。TeX 会忽略其后面的所有内容，直到行末。（您可能已经知道这一点）

对于较长的文本，您可以使用comment包来定义 LaTeX 忽略的环境。

\usepackage{comment}
% ...
\begin{comment}
 This text is ignored
\end{comment}

如果你的笔记是简单的文本，没有任何特殊的 TeX 宏（尤其是\if...宏），那么你可以使用\iffalse ... \fi这个

\iffalse
  This text is ignored, but should not include `if...` and `fi` macros
\fi

答案2

当然，你总是可以使用标准方法，%在每行之前放置，将一些文本转换为注释。但是如果你有大量关于内容的注释，有时你希望在 PDF 中显示这些注释（例如，在草稿中向你的论文导师展示），并且你想区分注释以了解下一段 LaTeX 代码或禁用它，那么这种标准方法是不够的。

以下两种方法可以轻松隐藏/取消隐藏其他类型的评论：

隐藏所有评论（没有 的评论%）。

  1. 在序言中定义一个新的命令（浪费想象力，我在 中想到了\comment），它什么都不做（参见 MWE）。然后你可以安全地使用注释\comment{老板太笨了，看不懂这一段话，用简单的词写一下。}

  2. 使用todonotes带有选项的包disable。

取消隐藏评论

  1. \comment禁用序言中的新命令（与%之前一样）并再次定义以显示其内容（最好使用与正文不同的格式）。
  2. 在todonotes包中删除该选项disable。额外优势：漂亮的待办事项列表。

我希望这两种方法都能在 MWE 中得到自我解释：

平均能量损失

\documentclass{article}
    \usepackage{xcolor}
    \usepackage{lipsum} % dummy text for the MWE

% Put % before of what you want disabled

% Select what to do with todonotes: 
% \usepackage[disable]{todonotes} % notes not showed
\usepackage[draft]{todonotes}   % notes showed

% Select what to do with command \comment:  
% \newcommand{\comment}[1]{}  %comment not showed
\newcommand{\comment}[1]
{\par {\bfseries \color{blue} #1 \par}} %comment showed


\begin{document}
\lipsum[1] 
\todo{This is a to do note at margin}
\lipsum[2] 
\comment{This is a simple comment between text} 
\lipsum[3]
\todo[inline]{This is a todo note inline} 
\comment{This is the end, check the to-do list}
\listoftodos
\end{document}

答案3

如果我理解你的问题没有错的话，%在行首使用 a。百分号表示注释，即未排版的文本。

\documentclass{article}
\begin{document}
This text will be in the PDF.
% This is a comment, and will not appear.
\end{document}

要在文本中打印百分号，请使用\%。

答案4

fixme如果您想在 pdf 文件中发表评论并可打开或关闭，您可以使用该包。

该包可以在这里找到：http://www.ctan.org/pkg/fixme。

您可以通过在序言中添加类似这样的内容来实现它：

\usepackage[draft]{fixme}
\fxsetup{layout=footnote, marginclue}

然后，您可以使用 在文本中发表评论\fxnote{...}。如果您输入final而不是 ，draft您的评论将不会显示在 pdf 文件中。

您可以使用命令获取所有注释的列表\listoffixmes。这是最简单的用法，fixme但它提供了许多其他可能性，例如注释和文本突出显示。

相关内容