C++ Doxygen实现功能分享

C++编程语言应用广泛，在很多领域中都体现了非常重要的作用。编程人员应用它能够在很到程度上提高程序开发的效率。在这里我们先来了解一下有关C++ Doxygen的应用方式，以方便大家的理解。

用C++ Doxygen进行可自动文档化的代码注释，可从代码中提取注释生成帮助文档。

在使用Doxygen时将需要安装下列软件：

1、安装Doxygen1.4.7，建议安装在“D:\Program Files\doxygen”

2、安装Graphviz-2.13，用于C++ Doxygen生成类图、关系图等图形，建议安装在D:\Program Files\ATT。

3、安装HtmlHelp1.3，用于生成CHM帮助文件，如果已安装了HtmlHelp其他版本则跳过。

下面对三种常见形式举例。

A. 文件头注释，\file, \brief

B. 类/结构体等的定义注释，先写名称，再写概要说明

C. 函数定义说明，先写名称，再写概要说明，然后写参数说明、返回值、注意事项、参见链接等

在函数定义中常用的有（1）参数 param（2）返回值 return （3）参见 see（4）注意项 note等

参数可指定in/out，例如@param[out] dest、@param[in,out] buffer

D. 成员变量的注释，如果注释写在变量右边，则加“<”，例如//!< ……

更深层次的标记请查看C++ Doxygen帮助中的“Documenting the code”，Doxygen用法后面演示说明。