Doxygen 用法

Doxygen 是一个基于命令行的实用工具。在命令行中调用 doxygen 并带上 --help 选项，将为您提供该程序的简要用法说明。

所有选项都包含一个前导字符 -，后跟一个字符和一个或多个参数，具体取决于选项。

要为您的项目生成手册，通常需要遵循以下步骤

1. 您使用特殊的文档块来注释您的源代码（参见特殊注释块一节）。
2. 通过使用 -g 选项调用 Doxygen，您可以生成一个配置文件（参见配置一节）。

   doxygen -g <config_file>
   

3. 您编辑配置文件以使其与您的项目匹配。在配置文件中，您可以指定输入文件和许多可选信息。
4. 您让 Doxygen 根据配置文件中的设置生成文档。

   doxygen <config_file>
   

如果您使用旧版 Doxygen 生成了配置文件，则可以通过运行带 -u 选项的 Doxygen 将其升级到当前版本。

doxygen -u <config_file>

原始配置文件中的所有配置设置都将复制到新配置文件中。任何新选项都将具有其默认值。请注意，您可能在原始配置文件中添加的注释将丢失。

微调输出

如果您想微调输出的外观，Doxygen 允许您生成默认样式表、页眉和页脚文件，然后您可以对其进行编辑。

• 对于 HTML 输出，您可以使用以下命令生成默认页眉文件（参见HTML_HEADER）、默认页脚（参见HTML_FOOTER）和默认样式表（参见HTML_STYLESHEET）。

  doxygen -w html header.html footer.html stylesheet.css <config_file>
  

  config_file 是可选的。如果省略，Doxygen 将搜索名为 Doxyfile 的文件并进行处理。如果也未找到，它将使用默认设置。

• 对于 输出，您可以使用以下命令生成 refman.tex 的第一部分和最后一部分（参见LATEX_HEADER和LATEX_FOOTER），以及该页眉包含的样式表（通常是 doxygen.sty）。

  doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
  

  如果您需要非默认选项（例如使用额外的 包），您需要创建一个正确设置了这些选项的配置文件，然后在生成的文件之后指定该配置文件（请务必先备份配置文件，以防您忘记指定其中一个输出文件而丢失）。
• 对于 RTF 输出，您可以使用以下命令生成默认样式表文件（参见RTF_STYLESHEET_FILE）。

  doxygen -w rtf rtfstyle.cfg
  

警告

当使用自定义页眉时，您有责任正确包含 Doxygen 所需的任何脚本和样式表，这取决于配置选项，并且在升级到新版本的 Doxygen 时可能会发生变化。

注意

• 如果您不想为配置文件中的每个项目生成文档，则可以使用可选的 -s 选项。这可以与 -u 选项结合使用，以从现有配置文件中添加或剥离文档。要获取最小配置文件，请使用 -x 或 -x_noenv 选项，以仅显示与默认 Doxygen 配置文件的差异。如果您向我发送配置文件作为错误报告的一部分或在 GitHub 上发布问题，请使用 -s 或 -x 或 -x_noenv 选项！（另请参阅：如何报告错误）
• 要让 Doxygen 从标准输入/输出而不是从文件读取/写入，请使用 - 作为文件名。

前往下一节或返回索引。