python - 我可以使用 doxygen 来记录命令行程序吗？

Question

我参与了一个大型代码项目，该项目使用 Doxygen 来记录一系列 C 库。我们也开始将 doxygen 与doxypy 一起用于相关的 python 模块。

是否有一种简单的方法来记录命令行程序（在 python 或 C 中）及其命令行选项，（自动）使用 doxygen？

Answer 1

为了生成man页面，您需要将GENERATE_MANtag 设置为 Yes (.doxyfile)。

默认情况下，在提供的目录中创建一个名为 man 的子文件夹，OUTPUT_DIRECTORY用于包含生成的页面。

通过这样做，doxygen 会将您添加到源代码中的所有标记呈现为手册页（每个翻译单元一页）。

此时，您可能想要使用exclude* 指令排除您想要忽略的某些部分（我假设您只想展示如何调用 main） 。

我建议您编译两个不同的 doxyfile：一个用于内部使用（完整的类似 javadoc 的文档），另一个用于生成程序 man 等。

当然，你不会在第一次尝试时得到预期的结果，你可能需要稍微使用一下 doxygen 标记。