documentation - 用于程序程序的 Doxygen

Question

我有一些大型的，主要是程序代码，需要详细记录。这通常涉及重复使用必须以特定顺序执行的许多功能。

Doxygen 是一个很棒的产品，但它似乎非常倾向于记录 OOP 代码。有没有人有关于如何以自然的方式使用 doxygen 来记录程序工作的任何提示？

Answer 1

doxygen 的工作方式本质上没有 OOP。它只是能够提取有关 OO 代码的更多信息，因为其中包含更多信息（例如，继承图）。

我们将 doxygen 用于纯 C 代码，它也可以正常工作，减去与 C++ 相比纯 C 不提供的信息。只需使用 doxygen 的分组（@addtogroup 等）功能来组织生成的文档，你就可以了。