Algoritmos y listados de código fuente
Un esbozo con algorithm2e y listings para código real.
Algoritmos y listados de código fuente
Los artículos presentan el código de dos maneras distintas, y LaTeX tiene una herramienta para cada una. El pseudocódigo es un esbozo idealizado de un algoritmo, compuesto con palabras clave y matemáticas, y se encarga de él el paquete algorithm2e. Los listados de código fuente son código real reproducido literalmente en una fuente monoespaciada, y se encarga de ellos el paquete listings. Elegir mal la herramienta es la fuente habitual de problemas, así que conviene ver las dos.
Pseudocódigo con algorithm2e
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}Las opciones del paquete fijan el estilo visual: ruled dibuja líneas horizontales encima y debajo del algoritmo y coloca el título arriba, la convención que esperan la mayoría de los congresos y revistas, mientras que vlined dibuja una pequeña línea vertical que marca la extensión de cada bloque, de modo que el anidamiento sigue siendo legible sin sangrías pesadas. El entorno algorithm es un flotante, como una figura, así que lleva el \caption que le da el número que \ref puede citar.
Dentro, \While{condition}{body} compone el bucle con una palabra clave en negrita, la condición y el cuerpo como un bloque con sangría. \For, \If y \Return siguen el mismo patrón. Las instrucciones terminan con \;, que imprime el terminador de la línea e inicia una línea nueva. Olvidarlo es el error clásico de quien empieza: las líneas se pegan unas a otras. Como esto es LaTeX normal, las matemáticas como $\theta$ funcionan en el texto, que es justo para lo que sirve el pseudocódigo: describir la regla de actualización con notación y no con un lenguaje concreto.
Código real con listings
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}El entorno lstlisting reproduce su contenido tal cual, conserva los espacios y trata los caracteres especiales de forma literal, así que puedes pegar código sin escapar nada. La opción language=Python activa el resaltado de palabras clave de ese lenguaje, y listings conoce decenas más. Por defecto, la salida es sencilla. La mayoría añade una sola vez en el preámbulo \lstset{basicstyle=\ttfamily\small, numbers=left} para obtener una fuente monoespaciada de tamaño razonable con números de línea. Para incluir un archivo directamente en lugar de pegarlo, \lstinputlisting[language=Python]{train.py} lo lee del disco, lo que mantiene el artículo sincronizado con el código real. Si quieres un resaltado en color y de alta fidelidad, el paquete minted es la alternativa más potente, a costa de requerir una herramienta externa y shell escape.
Cómo elegir entre ellos
Usa pseudocódigo en el cuerpo del artículo para comunicar la idea, y reserva los listados literales para los casos en que importa el código exacto, como los apéndices o las descripciones de herramientas. Un error frecuente es poner un lstlisting dentro de un frame de Beamer sin la opción [fragile], lo que falla con un error opaco; la misma advertencia aparece en una primera presentación con Beamer.