listings 是專用於程式碼排版的 LaTeX巨集包(及使用xltxtra進行中文支援)
阿新 • • 發佈:2019-01-30
listings 是專用於程式碼排版的 LaTeX
巨集包,可對關鍵詞、註釋和字串等使用不同的字型和顏色或顏色,也可以為程式碼新增邊框、背景等風格。
1 基本用法
下面給出一份用於排版 C 語言 HelloWorld 程式程式碼的完整的 LaTeX 文件:
\documentclass{article}
\usepackage{listings}
\begin{document}
\begin{lstlisting}[language=C]
int main(int argc, char ** argv) { printf("Hello world!\n");
return 0; }
\end{lstlisting}
\end{document}
注意,要使用 listings 巨集包提供的語法高亮,需要 xcolor 巨集包支援。
4 新增邊框
listings
巨集包為程式碼邊框提供了很多風格,大體可分為帶有陰影的邊框與圓角邊框。這裡僅僅給出一個陰影邊框的示例,至於其它邊框風格,可查閱
listings 巨集包文件,裡面給出了一些示例。
下面 LaTeX 源文件將為程式碼新增陰影邊框,並將陰影設定為淺灰色:
\begin{lstlisting}[language={[ANSI]C}, keywordstyle=\color{blue!70}, commentstyle=\color{red!50!green!50!blue!50}, frame=shadowbox, rulesepcolor=\color{red!20!green!20!blue!20}]
int main(int argc, char ** argv) { printf("Hello world!\n");
return 0; }
\end{lstlisting}
5 新增行號
很多時候需要對文件中的程式碼進行解釋,只有帶有行號的程式碼才可以讓解釋更清晰,因為你只需要說第
x
行程式碼有什麼作用即可。如果沒有行號,那對讀者而言就太殘忍了,他們不得不從你的文字敘述中得知行號資訊,然後去一行一行的查到相應程式碼行。
listings 巨集包通過引數 numbers 來設定行號,該引數的值有兩個,分別是
left 與
right,表示行號顯示在程式碼的左側還是右側。下面為帶有邊框的程式碼新增行號,並設定行號字型為
\tiny:
\begin{lstlisting}[language={[ANSI]C}, numbers=left, numberstyle=\tiny, keywordstyle=\color{blue!70}, commentstyle=\color{red!50!green!50!blue!50}, frame=shadowbox, rulesepcolor=\color{red!20!green!20!blue!20}]
int main(int argc, char ** argv) { printf("Hello world!\n");
return 0; }
\end{lstlisting}
6 全域性設定
上面所給的各個示例中,lstlisting
環境後面尾隨了很多引數,要是每使用一次 lstlisting
環境就要設定這麼多引數,那就沒什麼意思了。
可以使用 \lstset 命令在 LaTeX 源文件的導言區設定好 lstlisting
環境所用的公共引數,如下:
\documentclass{article}
\usepackage{listings}
\usepackage{xcolor}
\begin{document}
\lstset{numbers=left, numberstyle=\tiny,
keywordstyle=\color{blue!70},
commentstyle=\color{red!50!green!50!blue!50}, frame=shadowbox,
rulesepcolor=\color{red!20!green!20!blue!20} }
\begin{lstlisting}[language={[ANSI]C}]
int main(int argc, char ** argv) { printf("Hello world!\n");
return 0; }
\end{lstlisting}
\end{document}
7 顯示中文
listings 巨集包預設是不支援包含中文字串的程式碼顯示的,但是可以使用
“逃逸” 字串來顯示中文。
在 \lstset
命令中設定逃逸字串的開始符號與終止符號,推薦使用的符號是左引號,即
“ `”
\lstset{numbers=left, numberstyle=\tiny,
keywordstyle=\color{blue!70},
commentstyle=\color{red!50!green!50!blue!50}, frame=shadowbox,
rulesepcolor=\color{red!20!green!20!blue!20}, escapeinside=``}
……
\begin{lstlisting}[language={[ANSI]C}]
int main(int argc, char ** argv) { printf("`我愛中文`!\n");
return 0; }
\end{lstlisting}
另一種方法:
\documentclass[11pt,a4paper]{article}
\usepackage{xltxtra}
\usepackage{fontspec}
\usepackage{float}
\usepackage{listings}
\usepackage{xcolor}
\usepackage{color}
\usepackage[top=0.8in,bottom=0.8in,left=1.2in,right=0.6in]{geometry}
\lstset{
language=[ANSI]c,
basicstyle=\small,
numbers=left,
keywordstyle=\color {blue},
numberstyle={\tiny\color{lightgray}},
stepnumber=1, %行號會逐行往上遞增
numbersep=5pt,
commentstyle=\small\color{red},
backgroundcolor=\color[rgb]{0.95,1.0,1.0},
showspaces=false,
showtabs=false,
frame=shadowbox, framexleftmargin=5mm, rulesepcolor=\color{red!20!green!20!blue!20!},
% frame=single,
% TABframe=single,
tabsize=4,
breaklines=tr,
extendedchars=false %這一條命令可以解決程式碼跨頁時,章節標題,頁首等漢字不顯示的問題
}
%字型
\setmainfont[BoldFont={SimHei},ItalicFont={KaiTi}]{SimSun}
\setsansfont[BoldFont=SimHei]{KaiTi}
\setmonofont{NSimSun}
%%設定中文
%中文斷行
\XeTeXlinebreaklocale "zh"
\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
\begin{document}
此頁故意留作空白
\newpage
\subsection{LaTex漢字測試}
測試檔案
\lstinputlisting{src/function.h}
\lstinputlisting{src/function.c}
\begin{lstlisting}
int main(int argc, char ** argv)
{
/* 測試漢字註釋 */
printf("Hello world!\n");
return 0;
}
\end{lstlisting}
\end{document}
8 調整一下邊距 listings 的程式碼框的寬度預設是與頁芯等寬的,其上邊距也過於小,可根據自己的審美觀念適度調整一下。我通常是將程式碼框的左右邊距設定為 2em,上邊距為 1em,下邊距採用預設值即可,所作設定如下: \lstset{numbers=left, numberstyle=\tiny, keywordstyle=\color{blue!70}, commentstyle=\color{red!50!green!50!blue!50}, frame=shadowbox, rulesepcolor=\color{red!20!green!20!blue!20},escapeinside=``, xleftmargin=2em,xrightmargin=2em, aboveskip=1em}
\usepackage{xltxtra}
\usepackage{fontspec}
\usepackage{float}
\usepackage{listings}
\usepackage{xcolor}
\usepackage{color}
\usepackage[top=0.8in,bottom=0.8in,left=1.2in,right=0.6in]{geometry}
\lstset{
language=[ANSI]c,
basicstyle=\small,
numbers=left,
keywordstyle=\color
numberstyle={\tiny\color{lightgray}},
stepnumber=1, %行號會逐行往上遞增
numbersep=5pt,
commentstyle=\small\color{red},
backgroundcolor=\color[rgb]{0.95,1.0,1.0},
showspaces=false,
showtabs=false,
frame=shadowbox, framexleftmargin=5mm, rulesepcolor=\color{red!20!green!20!blue!20!},
% frame=single,
% TABframe=single,
tabsize=4,
breaklines=tr,
extendedchars=false %這一條命令可以解決程式碼跨頁時,章節標題,頁首等漢字不顯示的問題
}
%字型
\setmainfont[BoldFont={SimHei},ItalicFont={KaiTi}]{SimSun}
\setsansfont[BoldFont=SimHei]{KaiTi}
\setmonofont{NSimSun}
%%設定中文
%中文斷行
\XeTeXlinebreaklocale "zh"
\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
\begin{document}
此頁故意留作空白
\newpage
\subsection{LaTex漢字測試}
測試檔案
\lstinputlisting{src/function.h}
\lstinputlisting{src/function.c}
\begin{lstlisting}
int main(int argc, char ** argv)
{
/* 測試漢字註釋 */
printf("Hello world!\n");
return 0;
}
\end{lstlisting}
\end{document}
8 調整一下邊距 listings 的程式碼框的寬度預設是與頁芯等寬的,其上邊距也過於小,可根據自己的審美觀念適度調整一下。我通常是將程式碼框的左右邊距設定為 2em,上邊距為 1em,下邊距採用預設值即可,所作設定如下: \lstset{numbers=left, numberstyle=\tiny, keywordstyle=\color{blue!70}, commentstyle=\color{red!50!green!50!blue!50}, frame=shadowbox, rulesepcolor=\color{red!20!green!20!blue!20},escapeinside=``, xleftmargin=2em,xrightmargin=2em, aboveskip=1em}