Работа в системе LaTeX
de301fb4

Команда \newcommand со звездочкой


У команд \newcommand и \renewcommand существуют варианты " со звездочкой", называемые \newcommand* и \renewcommand. Они работают точно так же, как их тезки без звездочек, со следующим отличием: если команда с аргументами определена с помощью \newcommand* или \renewcommand*, то в ее аргументе не может содержаться пустая строка или команда \par. Если ваша команда определена с помощью \newcommand или \renewcommand без звездочки, то никаких ограничений на этот счет нет.

Смысл этого запрета таков. В большинстве случаев команды с аргументами, которые вы определяете, все равно не будут предусматривать подстановку вместо аргумента фрагмента текста, содержащего пустую строку или \par, так что этот запрет ни на чем не скажется (во всех примерах, приведенных в этой книге к настоящему моменту, можно совершенно безболезненно заменить \newcommand и \renewcommand на их варианты " со звездочкой"). А вот диагностика ошибок при наличии такого запрета облегчается. В самом деле, представим себе, что вы забыли набрать закрывающую фигурную скобку в аргументе команды (весьма распространенная ошибка!), как в следующем примере (забыта фигурная скобка в самой первой формуле; команду \smb мы определили в учебных целях раньше):

Символ Лежандра $\smb{a{l}$, где $a$ не делится на $l$, равен по определению $1$, если $a$ является квадратичным вычетом по модулю $l$, и $-1$ в противном случае. Вопрос о том, как зависит $\smb{a}{l}$ от $l$ при фиксированном $a$, является весьма важным и трудным. Великий немецкий математик К.-Ф.Гаусс...

Если пустые строки в аргументе команды \smb не запрещены (так оно и будет, если определять \smb с помощью \newcommand без звездочки), то TeX будет терпеливо ждать, когда ему встретится закрывающая фигурная скобка, парная к первой из открывающих фигурных скобок в первой строке, а пока таковой нет — рассматривать весь читаемый им текст как составную часть первого аргумента команды \smb. В конце концов TeX либо доложит, что он прочел уже весь файл, а закрывающей фигурной скобки так и не нашел, либо прервет работу, объявив, что ему не хватило памяти.


Если же мы определим \smb с помощью \newcommand*, написав

\newcommand*{\smb}[2]{\left(\frac{#1}{#2}\right)} то ошибка не пойдет дальше текущего абзаца: как только TeX увидит пустую строку среди текста, рассматриваемого им как аргумент команды, он тут же прервет дальнейшее чтение и выдаст следующее стандартное сообщение об ошибке:

Runaway argument? {a{l}$, где$a$ не делится на $l$, равен п\ETC. ! Paragraph ended before \smb was complete. <to be read again> \par l.8 ? Нажав пару раз на "ввод", мы сможем благополучно продолжить обработку текста. В первом абзаце пропадет все после слов "Символ Лежандра", зато второй и последующие абзацы будут обработаны нормально (пока TeX не наткнется на очередную ошибку...).

Команды \newcommand и \renewcommand* обладают еще одним преимуществом перед своими вариантами без звездочек: при их использовании происходит (небольшая) экономия памяти.

Рекомендуем вам определять и переопределять команды с аргументами при помощи \newcommand* и \renewcommand*. Варианты без звездочек используйте только тогда, когда вы действительно намерены подставлять в аргумент своего макроса текст, состоящий из нескольких абзацев.


Содержание раздела