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

Question

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

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

Answer 1

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

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

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

此时，您可能想要使用 exclude* directives 排除某些您想忽略的部分(我假设您只对展示如何调用 main 感兴趣) .

我建议你编译两个不同的 doxyfiles:一个用于内部使用(完整的类 javadoc 文档)，另一个用于生成程序 man 等。

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