Algoritmos e listagens de código

algorithm2e para esboçar algoritmos e listings para código real.

Algoritmos e listagens de código

Os artigos apresentam código de duas formas distintas, e o LaTeX tem uma ferramenta separada para cada uma. O pseudocódigo é um esboço idealizado de um algoritmo, composto com palavras-chave e matemática, e quem cuida dele é o pacote algorithm2e. As listagens de código-fonte reproduzem código real, literalmente, em fonte monoespaçada, e quem cuida delas é o pacote listings. Escolher a ferramenta errada é a fonte usual de atrito, então ajuda ver as duas.

Pseudocódigo com algorithm2e

\usepackage[ruled,vlined]{algorithm2e}
\begin{algorithm}
\caption{Train}
\While{not converged}{
Update $\theta$\;
}
\end{algorithm}

As opções do pacote definem o estilo visual: ruled traça filetes horizontais acima e abaixo do algoritmo e coloca a legenda no topo, a convenção que a maioria das conferências e dos periódicos espera, enquanto vlined traça uma pequena linha vertical que marca a extensão de cada bloco, de modo que o aninhamento fica legível sem recuos exagerados. O ambiente algorithm é um elemento flutuante (float), como uma figura, então ele leva o \caption que lhe dá um número para o \ref citar.

Dentro dele, \While{condition}{body} compõe o laço com uma palavra-chave em negrito, a condição e o corpo como um bloco recuado. \For, \If e \Return seguem o mesmo padrão. As instruções terminam com \;, que imprime o terminador da linha e começa uma nova linha. Esquecê-lo é o erro clássico de iniciante: as linhas ficam coladas umas nas outras. Como isso é LaTeX comum, a matemática como $\theta$ funciona no meio do texto, que é justamente o propósito do pseudocódigo: descrever a regra de atualização em notação, e não em uma linguagem específica.

Código real com listings

\usepackage{listings}
\begin{lstlisting}[language=Python]
def f(x):
return x**2
\end{lstlisting}

O ambiente lstlisting reproduz o conteúdo exatamente, preservando os espaços e tratando os caracteres especiais de forma literal, então você pode colar o código sem escapar nada. A opção language=Python ativa o destaque de palavras-chave dessa linguagem, e o listings conhece dezenas de outras. Por padrão, a saída é simples. A maioria das pessoas acrescenta uma vez, no preâmbulo, um \lstset{basicstyle=\ttfamily\small, numbers=left} para obter uma fonte monoespaçada em tamanho razoável, com números de linha. Para incluir um arquivo diretamente, em vez de colar o código, \lstinputlisting[language=Python]{train.py} lê o arquivo do disco, o que mantém o artigo em sincronia com o código-fonte real. Se você quer um destaque colorido e de alta fidelidade, o pacote minted é a alternativa mais forte, ao custo de exigir uma ferramenta externa e o shell escape.

Escolhendo entre os dois

Use pseudocódigo no corpo do artigo para comunicar a ideia e reserve as listagens literais para os casos em que o código exato importa, como apêndices ou descrições de ferramentas. Um erro comum é colocar um lstlisting dentro de um frame do Beamer sem a opção [fragile], o que falha com um erro obscuro; o mesmo cuidado aparece em uma primeira apresentação em Beamer.

Voltar para Kits de campo