我在一篇期刊论文中描述了一种算法。在这个算法中,我有几个变量。我给它们起了与源代码中相同的名称(算法的 C++ 源代码,而不是 LaTeX 源代码)。所以我有如下变量:
- 新的 (正在插入的新节点)
- 参考(任意选择节点)
- X(通用循环变量)
在计算机编程中,给变量赋予有意义的名称是一种很好的做法。然而,在阅读其他描述算法的文章时,我经常看到缩写名称。对我来说,缩写名称是:
- n
- r
- X
这是个好做法吗?编程和数学文本?
另一件事是在文本和算法环境中编写这些变量的方式。我应该使用:
$new$
\emph{new}
\textbf{new}
\textit{new}
或者使用内联文本中的一个约定和一个不同的 方程和算法环境中的一个?
我在该期刊的编辑手册中找不到任何相关信息,在 LaTeX 课程手册中也没有找到任何相关信息。他们只是说要将变量设为斜体,这样它们就不会与单位混淆(例如,W 可能与瓦特混淆)。
答案1
您问了两个不同的(有趣的)问题。
首先是关于名称。一般来说,数学家更喜欢通用名称(“n”、“r”和“x”),而程序员则更喜欢更长、更有意义的名称。对于你的情况,我会选择有意义的名称。
你的第二个问题是关于排版的。我认为计算机程序员的延迟承诺的做法对你很有帮助。写一个宏
\newcommand{\variable}[1]{%
... convention for typesetting #1 ...
}
并在文档中使用\variable{new}
。然后,您可以稍后将格式更改为您(或您的编辑)喜欢的任何格式。请参阅上面的评论,了解一些印刷方面的注意事项。
你甚至可以推迟承诺变量名称使用类似宏
\newcommand{\reference}{\variable{reference}}
每个变量名一个。如果有很多,您可以使用宏从列表中生成宏。