Doxygen

安装工具

doxygen

doxygen-1.8.13-setup.exe

graphviz

graphviz-2.38.msi

Graphviz软件是开源的图形可视化。可视化是图表的结构信息作为表示方式的抽象网络的示图和曲线图。有重要的应用在网络、生物信息学、软件工程、数据库、网页设计、机器学习、视觉界面中的其它技术领域。

htmlhelp

htmlhelp1.3.exe

Doxygen配置方法

打开doxywizard.exe

项目文件：

Doxyfile.rar

doxygen 的注释规范

标记的块的详细描述

JavaDoc style,C-style

/** * ... text ... */

Qt style

/*! * ... text ... */

中间*可以省略

/*! ... text ... */

至少两个C++注释行，每一行都有一个附加斜线或感叹号

/// /// ... text ... ///

或

//! //!... text ... //!

注意这种情况下需要一个单独的空行来结束注释。

多行块注释

/********************************************//** * ... text ***********************************************/

(note the 2 slashes to end the normal comment block and start a special comment block).

///////////////////////////////////////////////// /// ... text ... /////////////////////////////////////////////////

简要描述

使用\brief

/*! \brief Brief description. * Brief description continued. * * Detailed description starts here. */

JAVADOC_AUTOBRIEF设置为YES,Javadoc风格

/** Brief description which ends at this dot. Details follow * here. */

C++ comments:

/// Brief description which ends at this dot. Details follow /// here.

用特殊的C++风格的注释

/// Brief description. /** Detailed description. */

或
//! Brief description.

//! Detailed description