如何在 Doxygen 评论中直接包含 LaTeX 片段？答案

【问题标题】：How to include LaTeX snippets directly in Doxygen comments?如何在 Doxygen 评论中直接包含 LaTeX 片段？
【发布时间】：2011-02-03 00:53:33
【问题描述】：

我希望能够使用一些合适的编辑器在外部编辑一些 Doxygen cmets 的 LaTeX 部分。我只会将它用于复杂的环境。为此，我想我可以拥有仅 LaTeX 的文件并从 Doxygen 中包含它们。我确实为 \begin 和 \end 创建了 Doxygen 别名，以使语法兼容。

（例如，我知道如何设置 Emacs/AUCTex 以使用没有前导和文档结构的 LaTeX sn-ps。）

有没有办法在 Doxygen 注释中包含 .tex 文件的内容？我寻找类似于 \htmlinclude 的东西，但寻找的是 TeX 文件。考虑到我对仅使用 TeX 的外部源的要求，是否有某种方法可以模拟该功能？

【问题讨论】：

我们现在有一个专门的 TeX 问题问答网站。请在 tex.stackexchange.com 上再次询问您的问题
你有没有想过这个问题？我正在尝试做同样的事情 - 我已经尝试了 \include 和 \verbinclude 的几种变体，但我似乎无法让它工作......
抱歉，虽然我通读了 Doxygen 的文档，但当时我找不到办法。询问是出于教育目的，所以我最终放弃了。

标签： latex doxygen

【解决方案1】：

你可以使用类似的东西

\latexonly
\input <file>
\endlatexonly

其中<file> 是要包含的文件的路径，相对于生成 Latex 文档的目录的绝对或相对路径。

【讨论】：

【解决方案2】：

您尝试过\verbinclude 命令吗？此命令逐字包含文档中的任何文件（与 \include 不同，后者用于包含 source 文件）。

来自 doxygen 手册：

\verbinclude <file-name>

此命令在文档中逐字包含文件<file-name>。该命令相当于将文件粘贴到文档中，并在其周围放置\verbatim 和\endverbatim 命令。

doxygen 应该查找的文件或目录可以使用 doxygen 的配置文件的EXAMPLE_PATH 标签来指定。

编辑：我只是想到您可能希望在将文件的其余部分包含在文档中之前从 .tex 文件中删除序言。您可以使用\dontinclude 命令执行此操作，该命令与\line、\skip、\skipline 和\until 命令一起允许您包含特定文件的特定行/块。请参阅\dontincludedocumentation 中的示例。

【讨论】：

谢谢，但我想要的是让 LaTeX 宏在外部文档中工作。例如，图表会很庞大，更不用说丑陋了，只是坐在 cmets 中。我认为这样的“复杂”文档可以放在一些外部文件中。但我现在已经放弃了这个想法。
恐怕我不太明白你的评论。 \verbinclude 命令在构建文档期间将外部文件的内容包含在文档中，这不会影响您的源文件。
谢谢，但 verbinclude 不是解决方案。它抑制 LaTeX 宏。 LaTeX 环境中的所有代码都以源代码形式发出。因此，例如，如果我想用 LaTeX 绘制 UML 图，我会在页面上获得源标记，而不是我想要的图片。