Doxygen代码注释规范12 - 国内外标准规范.docxVIP

vaDoc风格）符号，告诉Doxygen这些是一些特殊的指令，通过加入这些指令以及配备相应的文字，可

vaDoc风格）符号，告诉Doxygen这些是一些特殊的指令，通过加入这些指令以及配备相应的文字，可

THD生成所有的变量和函数。（9）存储配置信息。到上一步Doxygen已经完全配置好，可以在Run中

eader-file][header-name]eg:@classCTestinc/clas

注释实例：如果对文件、结构体、联合体、类或者枚举的成员进行文档注释的话,并且要在成员中间添加注释,而

基于Doxygen的代码注释规范

表示必须参数一般@file后我们空着，Doxygen会默认为是@file所在文件的文件名。@brie

表示必须参数一般@file后我们空着，Doxygen会默认为是@file所在文件的文件名。@brie

释块开始使用两个星号*：Qt风格代码注释,即在C风格注释块开始处添加一个叹号!:使用连续两个

s.h可能产生的异常描述eg:@exception本函数执行可能会产生超出范围的异常Modules

};voidTest::func1InGroup1(){}voidTest::func2InGrou

1、Doxygen

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

Doxygen能将程序中的特定批注转换成为说明文件。它可以依据程序本身的结构，将程序中按规范注释的批注经过处理生成一个纯粹的参考手册，通过提取代码结构或借助自动生成的包含依赖图（includedependencygraphs）、继承图（inheritancediagram）以及协作图（collaborationdiagram）来可视化文档之间的关系，Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML等。

2、graphviz

Graphviz(GraphVisualizationSoftware)是一个由ATT实验室启动的开

源工具包,用于绘制DOT语言脚本描述的图形。

要使用Doxygen生成依赖图、继承图以及协作图，必须先安装graphviz软件。

3、HTMLHelpWorkShop

微软出品的HTMLHelpWorkShop是制作CHM文件的最佳工具，它能将HTML文件编译生成CHM文档。

Doxygen软件默认生成HTML文件或Latex文件，我们要通过HTML生成CHM文档，需要先安装HTMLHelpWorkShop软件，并在Doxygen中进行关联。

te@attention@warning@enum@var@class@exception主要用于函on的subsection

te@attention@warning@enum@var@class@exception主要用于函

on的subsection）。如果两个或更多成员有不同的类型，那么这个group会和自动产生的gro

以上C++注释行所组成的注释块,而每个注释行开始处要多写一个斜杠或写一个叹号：同样的，简要说明（br

Doxygen下载（doxygen-1.8.7-setup.exe）：

http://www.stack.nl/~dimitri/doxygen/download.html

graphviz（forwindows）下载：

/Download..php

HTMLHelpWorkSho1.32）下载：

/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe

软件安装都选择默认方式，点击下一步直至安装完成。

安装完后进行Doxygen配置时需要关联graphviz和HTMLHelpWorkShop的安装路径。

三、软件配置使用

我们的所有配置都在Doxywizard中进行，生成参考手册是通过运行Doxywizard得到。

（1）Wizard-Project最重要的是工作目录，源代码目录，生成参考文件目录三处的设定，其它项目名称、项目简介、版本和标识可以依照实际情况选填。

工作目录是新建的一个目录，在配置完成之后可以把配置文件存在这