doxygen是一款类似于javadoc风格的文档系统,支持c语言、c++、dl语言、objective-c语言。从一套归档源文件开始,可以生成html格式的在线类浏览器或者其他参考手册。小编提供的doxygen使用手册包含了用户指南、参考指南、为开发者提供的信息三大部分,帮助用户快速的掌握doxygen的使用方法。

doxygen功能
Doxygen已经支持生成ANSI编码的chm目录文件(index.hhc)!Doxygen通常是用作生成英文文档的,生成中文文档需要修改输入和输出的码制,这样可以改变解析方式,生成中文文档。但是,你必须意识 到,Doxygen在从注释中抽取信息是需要做语法解析的,这些解析都是基于英文的基础,不可能在这个层面上支持中文。
Doxygen 是一个 C++, C, Java, Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D语言的文档生成器。可以运行在大多数类Unix系统,以及Mac OS X操作系统和Microsoft Windows 。 初始版本的Doxygen借鉴了一些老版本DOC++的代码;随后,Doxygen源代码由Dimitri van Heesch重写。
使用说明
1、doxygen的安装非常简单, linux下可以直接下载安装包运行即可,下载源代码编译安装也是比较通用的编译安装命令。
2、在生成文档时可以定义项目属性以及文档生成过程中的很多选项,使用下面命令能够产生一个缺省的配置文件:doxygen -g [配置文件名]
3、可以根据项目的具体需求修改配置文件中对应的项,修改过的配置文件可以作为以后项目的模板。
4、让软件自动产生文档,平常的注释风格可不行,需要遵循自己的格式。
5、OK,代码编完了,注释也按照格式写好了,最后的文档是如何的哪?非常简单,运行下面的命令,相应的文档就会产生在指定的目录中:doxygen [配置文件名]
6、需要注意的是doxygen并不处理所有的注释,重点关注与程序结构有关的注释,比如:文件、类、结构、函数、变量、宏等注释,而忽略函数内变量、代码等的注释。