doxygen 命令_doxygen使用

前言

下面主要讲解linux下Doxygen命令行实现html文档生成的操作，当然也有界面版本操作方式，linux下安装doxygen-gui即可通过doxywizard开启界面操作，windows下也可以通过doxywizard.exe界面进行配置操作，具体的界面操作请参考其他网上文章，不过有一句话需要说明：会命令行操作的，应该都会界面操作，而会界面操作的就不一定会命令行操作了。

windows下的操作方式可以参考 使用doxygen生成chm范例

doxygen是什么

按照约定的格式注释源代码，用工具处理注释过的源代码产生文档。通过这种方式产生文档至少有以下好处：

便于代码和文档保持同步

可以对文档做版本管理

Doxygen就是这样的工具，Doxygen是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。很多编程语言都有类似的文档工具，例如：Java有javadoc，Ruby有rdoc。对于C/C++程序，我们可以用Doxygen生成文档。Doxygen有如下特点：

支持的编程语言：完全支持 C、C++、Java、IDL、Objective-C、Python、PHP、C#、Fortran、VHDL

输出格式：直接支持 HTML、Latex、RTF、manpage、Qt help project、XML，间接支持 chm、

Qt Compressed Help、Postcript和PDF；

兼容 JavaDoc、Qt-Doc、KDOC等类似工具；

支持平台：Unix(包括Linux)、MacOs、Windows等；

主页：http://www.doxygen.org/

邮件列表：

[email protected]

[email protected]

作者：Dimitri van Heesch ([email protected]) ；

Doxygen基本操作流程

按照Doxygen的约定，将代码“文档化”。这部分请参考 代码‘文档化’；

编写一个配置文件(Doxyfile)，用于配合Doxygen生成最终的文档。这部分请参考 编写一个Doxygen配置文件；

执行doxygen Doxyfile生成文档。

下面详细介绍每一个步骤。

代码‘文档化’

这一部分需要了解基本的注释规则和doxygen注释标记

doxygen注释规则

并非所有程序代码中的注释都会被 Doxygen 处理(除非在配置文件里使能了EXTRACT_ALL等选项)，必需依照正确的格式撰写，Doxygen 可处理下面两种类型的注解(注意：默认采用的JavaDoc风格，你也可以选择采用Qt或者c/c++风格),如下:

/**

* ...多行注释...

*

*/

/** ...单行注释... */

由于 Doxygen 认为注释是说明它下面的程序代码。所以,如果注释要与前面的程序码在同一行内,则需用下面这种型式的注释:

/**< ...代码同行情况的注释 */

注意,除**后多了一个

首先,我们先说明在 Doxygen 中对於类别或是函数注解的一个特定格式。

/**

*

* struct、class、functiond的简易说明...

*

* struct、class、functiond的详细说明...

* ...

*/

上面这个例子要说的是,在 Doxygen 处理一个类定义或是函数定义之上的注释时:

会先判断第一行为简易说明,这个简易说明将一直到遇见一个空白行的出现或是遇到第一个 . 为止;

之后的注解将会被视为详细说明。

另一种比较清楚的方式是指定@brief 的指令,这将会明确的告诉 Doxygen 哪个是简易说明。

doxygen在处理注释文档的时候，会进行如下的过程：

执行在文档中的特殊命令。命令都以''或'@'开始,二者是一样的，都是为了引出一个命令。例如'\brief','\details','@brief', '&