LaTeX Cookbook项目：如何在LaTeX文档中优雅地插入程序源代码

最新推荐文章于 2025-06-30 09:03:23 发布

原创最新推荐文章于 2025-06-30 09:03:23 发布 · 412 阅读

CC 4.0 BY-SA版权

LaTeX Cookbook项目：如何在LaTeX文档中优雅地插入程序源代码

引言

在技术文档编写过程中，程序源代码的展示是一个常见但需要技巧的任务。LaTeX作为专业的排版系统，提供了多种方式来插入和美化代码片段。本文将详细介绍三种主流方法：verbatim环境、listings宏包和minted宏包（虽然原文未提及minted，但作为重要补充），帮助读者在文档中优雅地展示代码。

为什么需要特殊处理代码插入

直接复制粘贴代码到LaTeX文档会导致以下问题：

缩进和空格可能丢失或改变
特殊字符（如_、$等）会被LaTeX解析
缺乏语法高亮，可读性差
无法添加行号等辅助元素

方法一：verbatim环境

基本用法

verbatim环境是LaTeX内置的最简单代码插入方式：

\begin{verbatim}
你的代码
\end{verbatim}

特点

保持原始格式（空格、换行等）
使用等宽字体
不支持语法高亮
适合简单代码片段

示例

\documentclass{article}
\begin{document}

Python代码示例：

\begin{verbatim}
def factorial(n):
    if n == 0:
        return 1
    else:
        return n * factorial(n-1)
\end{verbatim}

\end{document}

优缺点分析

优点：

无需额外宏包
简单易用
完全保留原始格式

缺点：

缺乏语法高亮
无法添加行号
不能自定义样式

方法二：listings宏包

基本配置

\usepackage{listings}

基本用法

\begin{lstlisting}[language=Python]
你的Python代码
\end{lstlisting}

高级定制

listings宏包提供了丰富的定制选项：

\lstset{
    language=Python,
    basicstyle=\ttfamily\small,
    keywordstyle=\color{blue},
    commentstyle=\color{green},
    stringstyle=\color{red},
    showstringspaces=false,
    breaklines=true,
    frame=single,
    numbers=left,
    numberstyle=\tiny\color{gray},
    stepnumber=1,
    numbersep=5pt
}

完整示例

\documentclass{article}
\usepackage{listings}
\usepackage{xcolor}

\definecolor{codegreen}{rgb}{0,0.6,0}
\definecolor{codegray}{rgb}{0.5,0.5,0.5}
\definecolor{codepurple}{rgb}{0.58,0,0.82}
\definecolor{backcolour}{rgb}{0.95,0.95,0.92}

\lstdefinestyle{mystyle}{
    backgroundcolor=\color{backcolour},   
    commentstyle=\color{codegreen},
    keywordstyle=\color{magenta},
    numberstyle=\tiny\color{codegray},
    stringstyle=\color{codepurple},
    basicstyle=\ttfamily\footnotesize,
    breakatwhitespace=false,         
    breaklines=true,                 
    captionpos=b,                    
    keepspaces=true,                 
    numbers=left,                    
    numbersep=5pt,                  
    showspaces=false,                
    showstringspaces=false,
    showtabs=false,                  
    tabsize=2
}

\lstset{style=mystyle}

\begin{document}

Python代码示例：

\begin{lstlisting}[language=Python]
import numpy as np

def sigmoid(x):
    """计算sigmoid函数值"""
    return 1 / (1 + np.exp(-x))

x = np.linspace(-5, 5, 100)
print(sigmoid(x))
\end{lstlisting}

\end{document}

优缺点分析

优点：

支持语法高亮
可添加行号
高度可定制
支持多种编程语言

缺点：

配置复杂
高亮效果不如专业IDE
需要额外宏包支持

方法三：minted宏包（补充内容）

虽然原文未提及，但minted是另一个强大的代码高亮解决方案。

基本配置

\usepackage{minted}

需要安装Python和Pygments包：

pip install pygments

编译时添加-shell-escape参数。

基本用法

\begin{minted}{python}
你的Python代码
\end{minted}

高级用法

\begin{minted}[
    linenos,
    frame=lines,
    framesep=2mm,
    baselinestretch=1.2,
    fontsize=\footnotesize,
    bgcolor=LightGray
]{python}
import numpy as np
print(np.__version__)
\end{minted}