如何在Doxygen注释中直接包含LaTeX代码片段？

Question

我希望能够使用适当的编辑器外部编辑一些Doxygen注释中的LaTeX部分，这些部分只用于复杂环境。为此，我想可以创建仅包含LaTeX内容的文件，并从Doxygen中引用它们。我已经创建了\begin和\end的Doxygen别名，以使语法兼容。

（例如，我知道如何设置Emacs/AUCTex以处理没有导言和文档结构的LaTeX片段。）

有没有一种方法可以在Doxygen注释中包含.tex文件的内容？我正在寻找类似于\htmlinclude的东西，但是针对TeX文件。是否有某种方法来模拟这个功能，满足我的要求，即具有仅包含TeX外部源的要求？

- simeonz

---

我们现在有一个专门的TeX问题问答网站。请在tex.stackexchange.com上重新提出您的问题。 - Andrew

你最终解决了这个问题吗？我也在尝试同样的事情——我已经尝试了几种\include和\verbinclude的变体，但似乎无法使其正常工作... - Xavier Holt

抱歉，尽管我仔细阅读了Doxygen的文档，但我无法找到一种方法在当时完成。由于询问是出于教育目的，最终我放弃了。 - simeonz

Answer 1

你可以使用类似以下的内容：

\latexonly
\input <file>
\endlatexonly

其中，<file>是要包含的文件路径，可以是绝对路径，也可以是相对于生成latex文档所在目录的相对路径。

- Abrixas2

Answer 2

你尝试过使用\verbinclude命令吗？该命令可以将任何文件原样包含在文档中（与用于包含源文件的\include相对）。

来自Doxygen手册：

\verbinclude <file-name>

此命令在文档中原样包含文件<file-name>。该命令等同于将文件粘贴到文档中并在其周围放置\verbatim和\endverbatim命令。

应指定Doxygen配置文件的EXAMPLE_PATH标记以指定Doxygen应查找的文件或目录。

编辑：我突然想到，您可能希望在将文件的其余部分包含在文档中之前从您的.tex文件中剥离前言。您可以使用\dontinclude命令来实现这一点，该命令与\line、\skip、\skipline和\until命令一起，允许您包含特定行/块的特定文件。请参见\dontinclude documentation中的示例。

- Chris

---

谢谢，但我想要的是让LaTeX宏在外部文档中起作用。例如，一个图表只放在注释中会很笨重，更不用说丑陋了。我曾经认为这样的“复杂”文档可以放在某个外部文件中。但现在我已经放弃了这个想法。 - simeonz

我恐怕不太理解你的评论。\verbinclude 命令在构建文档期间将外部文件的内容包含在你的文档中，但不会影响源文件。 - Chris

谢谢，但verbinclude不是解决方案。它会抑制LaTeX宏。所有在LaTeX环境中的代码都以源代码形式发出。因此，例如，如果我想使用LaTeX绘制UML图，我将在页面上获得源标记，而不是我想要的图片。 - simeonz