【Doxygen】Doxygen使用配置及注释语法规范

Doxygen使用配置及注释语法规范

程序的文件产生工具，可将程序中特定批注转换成为说明文件。

Doxygen的使用

• 特定格式的批注撰写
• 利用Doxygen的工具来产生文档

可处理的程序语言：C/C++、JAVA、IDL（Corda，Microsoft、KDE-DCOP类型）

可产生的文档格式：HTML、XML、LaTeX、RTF、Unix Man Page。

​ HTML可以打包成CHM格式，而LaTeX可以透过一些工具产生出PS或是PDF文档

产生文档的三个步骤：

1. 在程序代码中加上符合Doxygen所定义批注的格式
2. 使用Doxygen wizard进行配置。
3. 使用Doxygen来产生批注文档

Doxygen使用配置

使用Doxygen的GUI版本进行配置（Doxygen GUI frontend）

·Wizard -> Project

工作目录：存放配置文件的目录。

Project name：工程名字，项目名称。

Source code directory: 源码目录。

scan recursivery选项：是否支持递归搜索文件目录。需要勾选

Destionation directory：生成文档的存放目录。

·Wizard -> Mode

• 选择期望的提取模式

​ 仅文件实体

​ 所有实体

​ 在输出文档中包含交叉引用的源代码

• 选择编程语言去优化输出的结果

  这里支持C++

  C++/CLI

  Java或者C#

  C或者PHP

  等等

• 如果使用纯C语言编写的话，选择Optimize for C or PHP output 选项

·Wizard -> Output

• 选择生成的输出格式

​ HTML

​ 选择生成.chm格式的文档（compressed HTML）

​ LaTeX

​ as intermediate format for hyperlinked PDF:作为超链接PDF的中间格式

• Wizard -> Diagrams

• 选择生成图表的方式

  使用GraphViz Package的点工具生成图表

  （如果选择这个选项之前需要先安装了 Graphviz 工具包）

·Expert -> project

选择其输出文档的编码格式：UTF8 中文GB2312

设置输出文件的路径

设置输出文档的语言：如果有中文注释需要选择Chinese

向下拉滑动条看到JAVA_AUTOBRIEF和QT_AUTOBRIEF勾选上。

如果勾选就会默认第一行为简单说明，不勾选则需要@brief