How do you add a comment to pseudocode in LaTeX?

Question

Is there a special formatting to add comments to code? I mean I want to show comments in pseudocode that I write in LaTeX.

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

Edit: To be more clear, what I mean is in "algorithmic" syntax I write some pseudo code. However, I am not sure if there is a standard comment used in that context.

To clarify the question, please compose a small MWE that illustrates the problem including the \documentclass and the appropriate packages so that those trying to help don't have to recreate it. — Peter Grill, Nov 21 '11 at 17:57
Although this does not specifically address comments, if you are still trying to choose which package to use, an excellent summary is available at: print programs with its proper syntax — Peter Grill, Nov 21 '11 at 18:33

Werner · Answer 1 · 2011-12-10T21:00:43.013

Since you use the term algorithmic, I assume you're using the algorithms bundle (which provides the algorithmic package and environment). Then the \COMMENT{...} macro typesets a comment in pseudo-code:

enter image description here

\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}

If you're using the (more advanced) algorithmicx package (and use \usepackage{algpseudocode}, which also provides an algorithmic environment), then the \Comment{...} macro typesets a comment in pseudo-code:

enter image description here

\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}

In both these environments/packages, you are able to modify the formatting (or typesetting) of the comment. Alternatively, you could create your own \comment{...} macro as well, based on the existing commenting macros.

score 12 · Answer 2 · answered May 04 '18 at 17:38

12

You can use also \tcp{...} to add comments in algorithm2e environment.

answered May 04 '18 at 17:38

Hadij

360

3

algorithm2e is not algorithmic from the alogrithms bundle, so I don't see how this answers the question. – Andrew Swann May 04 '18 at 18:39
1

Thank you! This actually solves my problem. – Xuda Ye Apr 25 '23 at 00:07

score 2 · Answer 3 · answered Nov 21 '11 at 12:31

2

I found next possibilities:

Tab characters seem to work even in flexible columns.
escapechar=\% in options will turn on escape to LaTeX. Then, using %\mbox[2in][r]{comment}% should work, too.

answered Nov 21 '11 at 12:31

score 1 · Answer 4 · answered Apr 26 '22 at 07:14

1

You can try using

\tcc{the comment}

Example Latex code:

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

How it should be rendered:

answered Apr 26 '22 at 07:14

842Mono

111

How do you add a comment to pseudocode in LaTeX?

4 Answers4