Doxygen中文版(编程工具辅助)

Doxygen的开发作为方便和访问文件系统的C、C++、、Java中的Objective-C、Python中的IDL，并在一定程度上的php、C＃和D。欢迎需要的朋友在绿色资源网免费下载使用！

Doxygen软件介绍

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

程序语言

C/C++

Java

Objective-C

Python

IDL (Corba, Microsoft及KDE-DCOP类型)

Fortran

VHDL

PHP

C#

文件格式

HTML

XML

LaTeX

RTF (MS-Word)

PostScript

Unix Man Page

doxygen 教程

由于只是工具的使用，这里不介绍它的原理，直接从使用步骤开始。Doxygen的使用步骤非常简单。主要可以分为：

1）第一次使用需要安装doxygen的程序

2）生成doxygen配置文件

3）编码时，按照某种格式编写注释

4）生成对应文档

doxygen的安装非常简单， linux下可以直接下载安装包运行即可，下载源代码编译安装也是比较通用的编译安装命令。请参考其安装文档完成安装。

Doxygen在生成文档时可以定义项目属性以及文档生成过程中的很多选项，使用下面命令能够产生一个缺省的配置文件：

doxygen -g [配置文件名]

可以根据项目的具体需求修改配置文件中对应的项，具体的修改过程在下面介绍。修改过的配置文件可以作为以后项目的模板。

让doxygen自动产生文档，平常的注释风格可不行，需要遵循doxygen自己的格式。具体如何写doxygen认识的注释在第3节详细介绍。

OK，代码编完了，注释也按照格式写好了，最后的文档是如何的哪？非常简单，运行下面的命令，相应的文档就会产生在指定的目录中。

doxygen [配置文件名]

需要注意的是doxygen并不处理所有的注释，doxygen重点关注与程序结构有关的注释，比如：文件、类、结构、函数、变量、宏等注释，而忽略函数内变量、代码等的注释。