让符号保持一致的宏

newcommand、NewDocumentCommand 和共享的宏文件。

让符号保持一致的宏

每篇论文都有反复出现的符号:实数集、期望算子、竖线大小合适的绝对值。如果你在四十个地方输入 \mathbb{R},后来导师更喜欢 \mathbf{R},你就得改四十处,而且一定会漏掉一处。宏把这套符号变成一个有名字的命令,只定义一次。改了定义,整篇文档随之更新。这就是让符号保持一致的办法:源文件不可能自己和自己脱节。

用 newcommand 定义命令

\newcommand{\R}{\mathbb{R}}
\newcommand{\E}[1]{\mathbb{E}\left[#1\right]}
\newcommand{\abs}[1]{\left\lvert #1 \right\rvert}

第一个定义是最简单的一种:\R 现在纯粹是简写,在任何地方输入 \R 都会得到 \mathbb{R}。

第二个定义带一个参数。名字后面的 [1] 声明 \E 接受一个参数,#1 标出这个参数在展开结果中的位置。所以 \E{X} 会变成 \mathbb{E}\left[X\right]。这个定义带来的不只是简短:\left[ 和 \right] 这一对会让括号随内部内容增大,所以 \E{\frac{X}{n}} 会自动得到高大的括号。\abs 宏用 \lvert 和 \rvert 做同样的事,它们是表示绝对值的正确的一对竖线。你最多可以声明九个参数,并以 #1 到 #9 来引用它们。

如果命令已经存在,\newcommand 会拒绝重新定义它,并报错停止,这能保护你不会在不知不觉中弄坏什么。要有意替换现有的命令,请改用 \renewcommand。

现代接口

当前的 LaTeX 还自带一个功能更丰富的定义命令:

\NewDocumentCommand{\citepair}{mm}{\cite{#1}, \cite{#2}}

\NewDocumentCommand 使用一个参数说明字符串,而不是参数个数。这里的 mm 表示两个必选参数,所以 \citepair{knuth84}{lamport94} 会引用这两个键。这套说明语言能做到的比 \newcommand 更多:o 声明方括号中的可选参数,s 检测星号变体,O{default} 给可选参数一个默认值。凡是超出简单替换的需求,请使用这个接口。

共享这些定义

准备一个各章共享的 macros.sty。把你的定义都放进这一个文件,在每个文档里用 \usepackage{macros} 加载它,这样学位论文的每一章,以及幻灯片和论文版本,在符号上都保持一致。有协作者加入时,他们只要读一个简短的文件就能了解你的约定,而不必从正文里倒推。这与多文件结构天然相配。

关于命名的一个建议:给宏起有意义的名字,比如 \abs 或 \norm,而不是 \bigbars 这种按外观起的名字。名字应当说明这个符号的含义,这样定义就可以随意改变它的外观。另外,别为只用两次的东西定义宏;收益要到第三次使用左右才开始。

返回 运行时