Doxygen 是一个基于命令行的实用程序。在命令行中使用 doxygen 命令并加上 --help 选项，可以简要了解该程序的使用方法。

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

要为你的项目生成手册，通常需要执行以下步骤

如果你有一个使用旧版本 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 从标准输入/输出读取/写入，而不是从/向文件读取/写入，请使用 - 作为文件名。

转到下一部分或返回到索引。