doxygen(doxygen中文手册)

一个好的程序设计师，在写程序的时候总会在适当的地方添加合适的批注，而这些批注则能够有效的为用户提供最好的提醒和操作！但是想要写出好的批注就必须拥有合适的软件进行操作，而doxygen就是这么一款。完美的支持了C++、 C、Java、 Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D语言，能够运行在多种系统当中，比如说：Unix系统，以及Mac OS X操作系统和Microsoft Windows，在您写批注时，稍微按照一些它所制订的规则，接着就可以帮您产生出漂亮的文件了。(软件包中包含了中文手册，需要的朋友可以通过中文手册进行操作，手册打开需安装：)

使用步骤

1、第一次使用需要安装doxygen的程序
2、生成doxygen配置文件
3、编码时，按照某种格式编写注释
4、生成对应文档

特别提示

1、doxygen的安装非常简单， linux下可以直接下载安装包运行即可，下载源代码编译安装也是比较通用的编译安装命令。
2、在生成文档时可以定义项目属性以及文档生成过程中的很多选项，使用下面命令能够产生一个缺省的配置文件：doxygen -g [配置文件名]
3、可以根据项目的具体需求修改配置文件中对应的项，修改过的配置文件可以作为以后项目的模板。
4、让软件自动产生文档，平常的注释风格可不行，需要遵循自己的格式。
5、OK，代码编完了，注释也按照格式写好了，最后的文档是如何的哪？非常简单，运行下面的命令，相应的文档就会产生在指定的目录中：doxygen [配置文件名]
6、需要注意的是doxygen并不处理所有的注释，重点关注与程序结构有关的注释，比如：文件、类、结构、函数、变量、宏等注释，而忽略函数内变量、代码等的注释。