☰

如何在 LaTeX 中为伪代码添加注释？

tag-icon • tag-icon algorithms comments pseudocode
如何在 LaTeX 中为伪代码添加注释？

是否有特殊格式来向代码添加注释？我的意思是我想在用 LaTeX 编写的伪代码中显示注释。

this is code // this is comment part (the part that I want)

编辑：更清楚一点，我的意思是，我使用“算法”语法编写了一些伪代码。但是，我不确定该上下文中是否有标准注释。

答案1

既然你使用了这个术语algorithmic，我假设你正在使用algorithms捆（提供algorithmic包和环境）。然后\COMMENT{...}宏以伪代码形式排版注释：

在此处输入图片描述

\documentclass{article}
\usepackage{algorithmic}% http://ctan.org/pkg/algorithms
\begin{document}
\begin{algorithmic}[1]
  \STATE this is code \COMMENT{this is a comment}
\end{algorithmic}
\end{document}​

如果你使用（更高级的）algorithmicx包裹（并使用\usepackage{algpseudocode}，它也提供了一个algorithmic环境），然后\Comment{...}宏以伪代码形式排版注释：

在此处输入图片描述

\documentclass{article}
\usepackage{algpseudocode}% http://ctan.org/pkg/algorithmicx
\begin{document}
\begin{algorithmic}[1]
  \State this is code \Comment{this is a comment}
\end{algorithmic}
\end{document}​

在这两个环境/包中，您都可以修改注释的格式（或排版）。或者，您\comment{...}也可以基于现有的注释宏创建自己的宏。

答案2

您还可以使用它在环境\tcp{...}中添加评论。algorithm2e

答案3

我成立接下来的可能性：

  1. 制表符似乎即使在灵活的列中也能起作用。

  2. escapechar=\%在选项中将启用转义到 LaTeX。然后，使用%\mbox[2in][r]{comment}%也应该有效。

答案4

您可以尝试使用

\tcc{the comment}

Latex 代码示例：

\begin{algorithm}
\caption{Algorithm 1 title}
\tcc{the comment}
\end{algorithm}

应如何呈现：

渲染乳胶

相关内容