Doxygen学习小记

文档对于项目来说真的很重要，没有文档的代码就像纠缠在一起的一堆乱麻，剪不断理还乱。以前只看过很多开源项目里用

Doxygen生成的Documents，却从来没用过Doxygen，今天学习使用了下，发现真的很强大。

期间也遇到了一些问题，在此记录一下。

1. 使用Doxygen生成好文档后，发现有几个类不在里面。网上搜了很久，不得甚解。后来还是看官方手册发现Doxygen默认对预

编译是不处理的。而那几个类是在预定义里面的，所以Doxygen并没有生成。

解决方法：

设置EXPAND_ONLY_PREDEF为yes，然后在PREDEFINED里定义macro

see http://www.stack.nl/~dimitri/doxygen/preprocessing.html

2. private 成员没有生成

解决方法：

设置EXTRACT_PRIVATE为yes.

3.How to document the code

comment in QT-style:

在声明或定义前添加：

short description:

//! your description here

detail description

/*!

    your description here

*/

在类数据成员后面添加：

/!< your description here

一些常用的注释里的命令：

\param 函数参数说明

\return 函数返回值说明

\todo add to todo list