使用Doxygen为C\C++代码写文档

Doxygen是这样的一个工具，在我们写代码的同时，加上特定的注释，然后，Doxygen就利用这些注释生成漂亮的程序文档。


Doxygen是GPL众多优秀软件中的一员，当然，不仅仅在Linux平台有Doxygen，Doxygen还有Windows版本，而且他还提供了一个图形界面Doxywizard,使得使用Docxygen 更加方便。

按照Doxywizard的步骤，
首先，我们要生成配置文件，可以采用简单的方式，比如点击wizard按钮，配置好工程名(Project Name),工程的版本号，源文件的位置，以及代码文档的配置，其他默认，就可以简单地配置好一个C++环境的Docxyfile，而以这个为模板就可以生成相应的文档了；又或者点击Expert，可以更详细地配置Doxyfile，（注意，在expert选项里面可以选择中文生成中文文档）。
第二步，保存Doxyfile；第三步，选择工作目录；剩下的就是点击start生成文档了；
生成的文档可以有html,或latex以及其他例如RTF，xml。不过中文latex的话就要加相应的宏包。


说完Docxygen的使用方法，马上就要说说Doxygen的注释的写法，毕竟注释才是Doxygen生成文档的依据。

注释块可以是以下形式

 1*/

可以在注释块中加入下列元素来提示Docxygen来生成文档，

 1\struct  产生一个C语言的struct
 2\class   产生一个类的文档
 3\union   产生一个联合体的文档  
 4\enum    产生一个枚举类型的文档
 5\fn       函数
 6\var      变量
 7\def      #define 宏
 8\typedef  类型定义
 9\file    文件
10\namespace 命名空间
11\parm    函数的变量的注释
12\return  函数的返回值的注释
13\sa      参看
14\see     参考

不过以上的元素只是在注释块为

1*/

或

1*/

时才有效，而使用“@元素名”在

1*/

中是有效的。

还有可以利用"f[和"f]以及他们中间的LaTeX代码生成一个行间居中对齐的数学公式，或利用"f$和"f$以及LaTeX代码来生成数学公式。

下面来一个例子，（Doxygen帮助里的一个例子）

 1,size_t);

以及一个对类的注释（注意里面对成员变量的注释）

 1;

生成的文档如例一/Files/lyq105/refman1.pdf

                 以及 /Files/lyq105/refman2.pdf