演算法與原始碼清單

用 algorithm2e 排版演算法,用 listings 排版實際程式碼。

演算法與原始碼清單

論文呈現程式碼有兩種不同的形式,LaTeX 為每一種都準備了專用的工具。虛擬碼是演算法的理想化草圖,以關鍵字和數學式排版,由 algorithm2e 套件處理。原始碼清單是以等寬字型原樣重現的實際程式碼,由 listings 套件處理。選錯工具是最常見的麻煩來源,所以兩種都看一下會有幫助。

用 algorithm2e 排版虛擬碼

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

套件選項決定視覺樣式:ruled 會在演算法上下各畫一條水平線,並把標題放在頂端,這是多數會議和期刊期待的慣例;vlined 則畫一條細細的垂直線,標示每個區塊的範圍,這樣不必大幅縮排,巢狀結構也容易閱讀。algorithm 環境是浮動體,和圖片一樣,所以要加上 \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 escape。

如何選擇

在論文正文中用虛擬碼傳達想法,把原樣的程式碼清單留給確實需要精確程式碼的成品,例如附錄或工具說明。一個常見的錯誤,是在 Beamer 投影片框架內使用 lstlisting 卻沒加 [fragile] 選項,結果會出現難以理解的錯誤;第一份 Beamer 簡報中也有同樣的提醒。

返回 領域工具包