算法与源代码清单
用 algorithm2e 编写伪代码草图,用 listings 排版真实代码。
算法与源代码清单
论文以两种不同的形式呈现代码,而 LaTeX 为每种形式提供了单独的工具。伪代码是算法的理想化草图,用关键字和数学进行排版,algorithm2e 包负责处理它。源代码清单是以等宽字体逐字复现的真实代码,listings 包负责处理这些。选错工具通常是摩擦的根源,因此同时了解两者会有帮助。
使用 algorithm2e 的伪代码
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}包选项设置视觉样式:ruled 在算法上方和下方绘制水平线并把标题放在顶部,这是大多数期刊和会议期望的惯例;vlined 则绘制一条小竖线标记每个块的范围,这样即使嵌套不多加缩进也能保持可读。algorithm 环境是一个浮动体,就像 figure 一样,因此它带有 \caption,为其提供一个编号供 \ref 引用。
在内部,\While{condition}{body} 用粗体关键字、条件和作为缩进块的主体来排版循环。\For、\If 和 \Return 遵循相同的模式。语句以 \; 结尾,它会打印该行的结束符并开始新的一行。忘记它是典型的初学者错误:各行会连在一起。因为这是普通的 LaTeX,像 $\theta$ 这样的数学可以内联使用,这正是伪代码的用途:用符号而不是某种具体语言来描述更新规则。
用 listings 排版真实代码
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}lstlisting 环境会准确复现其内容,保留空白并按字面处理特殊字符,因此你可以直接粘贴代码而无需转义任何内容。language=Python 选项会为该语言打开关键字高亮,listings 还认识几十种其他语言。默认情况下输出是朴素的。大多数人会在导言区一次性添加 \lstset{basicstyle=\ttfamily\small, numbers=left},以获得大小合适、带行号的等宽字体。要直接包含文件而不是粘贴,\lstinputlisting[language=Python]{train.py} 会从磁盘读取它,使论文与实际源代码保持同步。如果你想要彩色、高保真的语法高亮,minted 包是更强大的选择,代价是需要外部工具和 shell 转义。
如何在两者之间选择
在论文正文中使用伪代码来传达思想,把逐字的代码清单留给对代码精确性有要求的场合,例如附录或工具说明。一个常见的错误是把 lstlisting 放进没有 [fragile] 选项的 Beamer frame 里,这会以一个难懂的错误告终;同样的注意事项也出现在第一份 Beamer 幻灯片中。