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

Question

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

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

Answer 1

要生成man个页面，您需要将GENERATE_MAN标记设置为Yes（.doxyfile）。

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

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

此时，您可能希望使用exclude* directives排除您要忽略的某些部分（我假设您只想显示如何调用主要部分）。

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

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