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

Question

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

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

有没有办法在Doxygen评论中包含.tex文件的内容？我寻找类似于\htmlinclude的东西，但是对于TeX文件。考虑到我对只有TeX的外部源的要求，有没有办法模拟功能？

Answer 1

您可以使用类似

的内容

\latexonly
\input <file>
\endlatexonly

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

Answer 2

您是否尝试过\verbinclude命令？此命令包含文档中的任何文件（与\include相反，后者用于包含源文件）。

来自doxygen手册：

  

\verbinclude <file-name>

     

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

     

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

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