記法を一貫させるマクロ

newcommand、NewDocumentCommand、共有のマクロファイル。

記法を一貫させるマクロ

どの論文にも、繰り返し現れる記法があります。実数全体、期待値の演算子、大きさが適切な縦線を使った絶対値などです。\mathbb{R} を 40 か所に入力していて、あとから指導教員が \mathbf{R} のほうがよいと言い出したら、40 回の修正が必要になり、1 つは見落とします。マクロは、その記法を名前の付いた 1 つのコマンドにして、一度だけ定義します。定義を変えれば、文書全体がそれに従います。これが記法を一貫させる方法です。ソースが自分自身と食い違うことはありません。

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} が出力されます。

2 つ目の形は引数を取ります。名前のあとの [1] は、\E が引数を 1 つ受け取ることを宣言し、#1 は、展開結果のどこにその引数が入るかを示します。そのため \E{X} は \mathbb{E}\left[X\right] になります。この定義の利点は、短く書けることだけではありません。\left[ と \right] の組によって、括弧が中身の大きさに合わせて伸びるので、\E{\frac{X}{n}} も、背の高い括弧で自動的に囲まれます。\abs マクロも、絶対値に適した縦線の組である \lvert と \rvert で同じことをしています。引数は最大 9 個まで宣言でき、#1 から #9 で参照します。

すでに存在するコマンドは、\newcommand では再定義できず、エラーで止まります。気づかないうちに何かを壊してしまうことを防ぐためです。既存のコマンドをあえて置き換えるには、代わりに \renewcommand を使います。

新しいインターフェース

最近の LaTeX には、より表現力の高い定義コマンドも付属しています。

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

\NewDocumentCommand は、引数の個数ではなく、引数の仕様を表す文字列を使います。ここでの mm は必須引数が 2 つという意味で、\citepair{knuth84}{lamport94} は 2 つのキーを両方とも引用します。この仕様の記述は、\newcommand ではできないところまで踏み込んでいます。o は角括弧の任意引数を宣言し、s は星付きの変種を検出し、O{default} は任意引数に既定値を与えます。単純な置換より込み入ったことをするなら、このインターフェースを使いましょう。

定義を共有する

章をまたいで共有する macros.sty を 1 つ用意します。定義をその 1 つのファイルにまとめ、各文書から \usepackage{macros} で読み込めば、学位論文のすべての章、さらにスライドと論文版まで、記法がそろいます。共同作業者が加わったときも、本文から記法の約束事を逆算する代わりに、短いファイルを 1 つ読むだけで済みます。これは複数ファイルの構成と相性がよい方法です。

名前の付け方のコツがあります。\bigbars のような見た目に基づく名前ではなく、\abs や \norm のように意味のある名前を付けてください。名前は記法の意味を表すべきであり、そうすれば定義は見た目を自由に変えられます。そして、2 回しか使わないもののためにマクロを定義するのは控えましょう。元が取れるのは、3 回目の使用あたりからです。

ランタイム に戻る