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

录里，每次从这个目录中导入配置文件（.cfg），然后进行说明文档生成。源代码目录和最终的结果目录在每idfunc1InGroup1();voidfunc2InGroup1();//@}/**Funct

录里，每次从这个目录中导入配置文件（.cfg），然后进行说明文档生成。源代码目录和最终的结果目录在每

idfunc1InGroup1();voidfunc2InGroup1();//@}/**Funct

oxygen识别并处理过的注释不显示，其余注释会显示出来。附加问题：1.如何隐藏源码？开发者不愿意公

Doxygen下载（doxygen-1.8.7-setup.exe）：http://www.stac

基于Doxygen的代码注释规范

完成后在输出目录中的html文件夹中找到index.chm文件即为输入代码的文档说明。四、Doxygf为简明注释

完成后在输出目录中的html文件夹中找到index.chm文件即为输入代码的文档说明。四、Doxyg

f为简明注释@aothor为作者列表@date为日期@version为版本号@note为注解一个文件

这些注释往往都是在每个成员后面。为此,可以使用在注释段中使用标识。对一个类的注释例子如下：（3

up中所有的members有相同的type和protectionlevel（例如都是staticpu

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中进行关联。

on的subsection）。如果两个或更多成员有不同的类型，那么这个group

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

粹的参考手册，通过提取代码结构或借助自动生成的包含依赖图（includedependencygrap

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

配置都在Doxywizard中进行，生成参考手册是通过运行Doxywizard得到。（1）Wizar

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