c++ - 使用 Doxygen 绘制控制理论框图

Question

我正在从事自动化领域的 C++ 项目，我想开始记录。我宁愿选择 Doxygen。但是，除了记录特定的数据字段和绘制类层次结构 UML 图之外，我还想用像这样的方框图来记录几种方法的功能:

解决方案是什么？

我熟悉 LaTeX。我读过 Doxygen 对 LaTeX 有一些支持，但我不知道这能走多远。是否可以在 Doxygen 中使用任何 LaTeX 包？您会推荐哪些特定的软件包，您能否提供一些简单的示例？

我也乐于接受与 Doxygen 不同的建议。

Answer 1

如果只是为了记录控制系统结构、变量等，您可以在其他地方生成图表(例如 Dia、XFig 或 Inkscape，如果您想使用开源工具)并通过图像将它们嵌入到您的 Doxygen 文档中代码中的关键字:

/*!
.. Doxygen doc here..
\image html Data_Model.png "Figure 1: UML Diagram of the Data Source and Data Model Relationships"
*/

为此，您需要在 Doxyfile 文件中告诉 Doxygen 在哪里可以找到图像，并将图像放置在与您的 doxygen 路径相关的位置(本例中为 DOCROOT/images):

# The IMAGE_PATH tag can be used to specify one or more files or 
# directories that contain image that are included in the documentation (see 
# the \image command).

IMAGE_PATH             = images

使用 latex 扩展或其他语言驱动的图形标记从 Doxygen 文档中生成图形并不能证明学习语言、配置和对齐工具链的开销是合理的。另一方面，如果您已经有一些工具可以自动生成图形(从您的代码或配置文件)，那么从 Makefile 中运行该工具应该是一件轻而易举的事，让它生成图像并将图像嵌入到您的 doxygen 文档通过 image 关键字。