doxygen
doxygen 参数类型
doxygen 参数类型摘要：1.Doxygen 简介2.Doxygen 参数类型概述3.Doxygen 参数类型的分类4.常见Doxygen 参数类型介绍5.Doxygen 参数类型的使用示例6.总结正文：【1.Doxygen 简介】Doxygen 是一个用于从源代码中生成文档的工具，特别适用于C、C++ 和Java 等编程语言。
它可以自动提取代码中的类、函数、变量等信息，并生成结构清晰、易于理解的文档。
在编写项目文档时，利用Doxygen 可以大大提高效率。
【2.Doxygen 参数类型概述】Doxygen 参数类型指的是在生成文档过程中，Doxygen 可以识别的变量、函数、类等元素的类型。
通过指定不同的参数类型，可以控制Doxygen 如何处理这些元素，以及在生成的文档中如何呈现。
【3.Doxygen 参数类型的分类】Doxygen 参数类型主要分为以下几类：- 变量类型（如：int、float、double 等）- 函数类型（如：void、int、void 等）- 类类型（如：class、struct 等）- 枚举类型（如：enum 等）- 宏类型（如：#define、#ifdef 等）【4.常见Doxygen 参数类型介绍】以下是一些常见的Doxygen 参数类型及其介绍：- `int`: 整型变量或函数返回值类型- `float`: 浮点型变量或函数返回值类型- `double`: 双精度浮点型变量或函数返回值类型- `void`: 函数无返回值类型，或表示某个变量没有值- `char`: 字符型变量或函数返回值类型- `const`: 常量类型，表示不可修改的变量或函数参数- `volatile`: 表示变量的值可能会被其他线程修改- `static`: 表示静态变量或函数，仅在定义它的源文件中有效- `class`: 表示一个类，包含类的成员变量和成员函数- `struct`: 表示一个结构体，包含结构体的成员变量和成员函数- `enum`: 表示一个枚举类型，包含一组有名字的常量- `#define`: 表示一个预处理器宏，用于定义常量或条件编译- `#ifdef`: 表示一个预处理器指令，用于检查某个宏是否已定义【5.Doxygen 参数类型的使用示例】以下是一个简单的Doxygen 参数类型使用示例：```c++/*** @file example.cpp* @brief 示例文件*//*** @class Example* @brief 示例类*/class Example {public:/*** @brief 示例类的构造函数*/Example();/*** @brief 示例类的析构函数*/~Example();/*** @brief 示例类的成员函数* @param int value 传入的整数值* @return int 返回的整数值*/int add(int value);};Example::Example() {/*** @brief 示例类的构造函数实现*/}Example::~Example() {/*** @brief 示例类的析构函数实现*/}int Example::add(int value) {/*** @brief 示例类的成员函数实现* @return int 返回的整数值*/return value + 1;}```在上述示例中，`Example` 类是一个示例类，包含一个构造函数、一个析构函数和一个成员函数。
doxygen注释规则
Doxygen注释规则1. 简介Doxygen是一种文档生成工具，能从源代码中提取结构、关系等信息，并生成API文档。
Doxygen可以对C、C++、Java、Python等语言的代码进行注释，帮助开发者理解复杂的代码结构和函数之间的关系。
本文档将详细介绍Doxygen的注释规则，以帮助开发者更有效的使用该工具。
2. 文件注释Doxygen支持在每个源文件中添加一个全局的文件注释。
这个注释会被Doxygen用来生成目录页。
格式如下：/*** @file example.cpp* @brief Example description* @author Your Name* @date Date of creation* @version V1.0* @brief This is a brief description of the file.*/3. 类和结构体注释对于类和结构体，Doxygen需要使用`@class`或`@struct`命令。
同时，也需要提供类的简短描述和详细描述。
格式如下：/*** @class MyClass* @brief A brief description of MyClass.* Detailed description...*/4. 类成员变量和函数注释对于类的成员变量和函数，Doxygen使用`@var`、`@member`、`@param`、`@return`等命令。
这些命令后面都需要接上描述信息。
格式如下：/*** @var int myVar This is a variable description.* @member void MyClass::myFunction() This is a function description.* @param int x This is a parameter description.* @return int This is a return value description.*/5. 特殊注释标签Doxygen还提供了一些特殊的注释标签，如`@todo`、`@bug`、`@deprecated`等，用于标记代码的特殊状态。
doxygen格式进行函数注释的格式
doxygen格式进行函数注释的格式一、引言在软件开发过程中，良好的代码注释是非常重要的，它能够帮助开发者理解代码逻辑、提高代码可读性，并方便后续的维护和修改。
而d o xy ge n是一种用于生成软件文档的工具，它支持多种编程语言，并且提供了一套注释格式规范，能够方便地生成代码文档。
二、什么是d o x y g e nd o xy ge n是一款开源的软件文档生成工具，它支持C、C++、J av a等多种编程语言，能够根据代码中的注释生成详细的文档内容。
通过d o xy ge n生成的文档，可以包含函数、类、结构体的详细说明，以及函数的参数、返回值等相关信息。
三、函数注释的格式在d ox yg en中，函数注释的格式规范是非常重要的，它能够决定最终生成的文档内容的结构和格式。
下面是一些常用的函数注释格式：1.函数说明/***@br ie f函数功能说明*@pa ra m参数1参数1的说明*@pa ra m参数2参数2的说明*@re tu rn返回值的说明*/在函数注释的第一行可以使用`@br ie f`标签来说明函数的功能，后续可以使用`@pa ra m`标签来说明函数的参数，使用`@re tu rn`标签来说明函数的返回值。
2.参数说明/***@pa ra m参数1参数1的说明*@pa ra m参数2参数2的说明*/在函数注释中，使用`@pa ra m`标签来说明函数的参数，可以对每个参数进行详细的说明。
3.返回值说明/***@re tu rn返回值的说明*/使用`@re tu rn`标签来说明函数的返回值，可以对返回值的含义进行说明。
四、示例下面是一个示例函数的注释格式：/***@br ie f计算两个整数的和*@pa ra ma第一个整数*@pa ra mb第二个整数*@re tu rn两个整数的和*/i n ta dd(i nt a,in tb){r e tu rn a+b;}通过以上的注释格式，我们在生成文档时就能够清晰地了解函数的功能、参数和返回值。
什么是Doxygen
什么是Doxygen?Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。
通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。
大部分有用的批注都是属于针对函式，类别等等的说明。
所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。
不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。
一个好的程序设计师，在写程序时，都会在适当的地方加上合适的批注。
如果，能够在撰写批注时，稍微符合某种格式，接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。
这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。
Doxygen 就是这样的一个工具。
在您写批注时，稍微按照一些它所制订的规则。
接着，他就可以帮您产生出漂亮的文件了。
因此，Doxygen 的使用可分为两大部分。
首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文件。
目前Doxygen可处理的程序语言包含：•C/C++•Java•IDL (Corba, Microsoft及KDE-DCOP类型)而可产生出来的文件格式有：•HTML•XML•LaTeX•RTF•Unix Man Page而其中还可衍生出不少其它格式。
如有了LaTeX 文件后，就可以透过一些工具产生出PS或是PDF档案。
在多国语言的支持方面，Doxygen 目前可支持的约有2,30种。
自Doxygen 1.2.16开始支持繁体中文(这正是小弟做的好事)。
所以在目前一些Open Source 的程序文档管理器中，Doxygen 算是相当完整的一套。
在程序语言处理上面，Doxygen也算是少数在Borland C++ Builder 的语法下还能够正常运作的工具之一（若非如此，小弟也不会推荐它）。
本文的目的是希望在经过仔细阅读本文之后能够给大家一个概略性的了解。
doxygen注释详解-附有生成文档的对照
retval指令操作符讲解
retval：指定函数返回值说明指令操作符。(注:更前面的return有点不同.这里是返回值说明) retval格式如下： @retval 返回值 简要说明 例:
/** *文件关闭函数 * @param file文件编号。 * @retval 0 表示成功 * @retval -1 表示失败 */ int CloseFile(int file);
专家(Expert)模式
专家(Expert)对话框----Input相关选项
指定输入源文件目录（INPUT）. 输入文件编码（INPUT_ENCODING）改 为GBK.
对文件过滤选项,我们这里只填*.c *.h.
专家(Expert)模式
专家(Expert)对话框----Messages相关选项
note 指令操作符讲解
note：指定函数注意项事或重要的注解指令操作符。
note格式如下： @note 简要说明
例: /** *打开文件函数 *@Param [in] name 文件名 *@Param [in] “rb” 打开模式 *@return 返回文件编号 *- -1表示打开文件失败 *@note 文件打开成功后,必须使用 CloseFile 函数关闭 */ int OpenFile(U8* file_name, U8* file_mode);
Doxygen详解 目录
使用Doxygen的目的. 安装Doxygen所需工具. 配置Doxygen Doxygen注释风格
使用Doxygen的目的
生成模块文档，方便以后维护模块代码。 提高代码可读性。 提高项目代码的管理。 省略了自己写readme文件（或文档）。
doxygen 函数代码单行注释
在软件开发中，注释是一种非常重要的编程实践，它可以帮助开发者更好地理解代码、提高代码可读性和可维护性。
而在注释中，函数代码的单行注释是一种常见的方式，它可以在一行内就给出对函数的解释和说明。
让我们来看一下什么是Doxygen。
Doxygen是一个广泛使用的工具，它可以从C++、C、Java等多种程序中提取注释，文档化代码。
这个工具能够以较为规范的方式记录代码注释，并生成代码文档。
在Doxygen中，函数代码的单行注释可以被视为标准的注释格式，从而可以被Doxygen正确地解析和转换为文档。
在实际使用Doxygen进行代码注释时，我们需要注意一些关键点。
首先是注释的格式。
对于函数的单行注释，我们通常会在函数定义的上方，使用连续两个斜杠“//”来注释。
接着是对函数的简要说明，包括函数的功能、参数和返回值等。
在Doxygen中，我们可以使用一些特定的标签来标记函数的参数和返回值，例如@param和@return等。
在撰写函数代码单行注释时，我们应该尽量做到深度和广度兼具。
深度上，我们应该从简单的功能和语法说明开始，逐步深入到函数的应用场景、注意事项、使用示例等方面。
而在广度上，我们应该考虑到不同读者的需求，包括初学者、中级开发者和专业开发者等，从而使得注释能够满足不同层次的读者对函数的理解和运用。
从个人角度来看，函数代码的单行注释是一种非常有效的注释方式，它能够在短时间内给出对函数功能和使用方法的简明说明。
但需要注意的是，单行注释可能有字数限制，无法提供过多细节，这就需要在其他地方进行补充说明。
单行注释也容易被滥用，因此在撰写过程中，我们需要注意控制注释的长度和内容，避免出现冗长、无用的注释。
总结而言，Doxygen的函数代码单行注释是非常有价值的，它能够帮助我们更好地理解和使用函数。
在注释时，我们需要遵循规范的格式和标签，做到深度和广度兼具，以满足不同读者的需求。
我希望未来在撰写代码注释时，能够更加注意注释的质量和适用性，让注释真正成为代码文档中的宝贵财富。
doxygen源码编译
doxygen源码编译摘要：1.Doxygen 简介2.Doxygen 源码编译步骤3.Doxygen 源码编译实例4.Doxygen 源码编译注意事项正文：【Doxygen 简介】Doxygen 是一个用于生成API 文档的工具，它可以从C、C++、Java 等源代码文件中提取函数、类、变量等信息，并生成HTML 格式的文档。
Doxygen 支持多种编程语言，具有用户友好的界面，可以方便地为开发者提供详细的API 参考。
【Doxygen 源码编译步骤】1.下载Doxygen 源码：访问Doxygen 官网（https://www.doxygen.nl/）下载最新版本的Doxygen 源码。
2.解压：将下载的压缩文件解压到一个目录下，例如：/usr/local/doxygen。
3.配置编译环境：检查Doxygen 依赖的库，并确保它们在您的系统中已安装。
对于C++编译器，推荐使用g++。
4.编译Doxygen 源码：在解压后的目录下，打开终端，执行以下命令进行编译：```make```5.安装Doxygen：编译成功后，在解压后的目录下执行以下命令安装Doxygen：```sudo make install```【Doxygen 源码编译实例】假设我们已经完成了Doxygen 源码的编译，现在我们以一个简单的C 语言示例来演示如何使用Doxygen 生成API 文档。
1.创建一个C 源文件：`example.c`，内容如下：```c#include <stdio.h>int add(int a, int b) {return a + b;}int subtract(int a, int b) {return a - b;}```2.使用Doxygen 生成文档：在终端中切换到包含`example.c`的目录，执行以下命令：```doxygen example.c```3.查看生成的文档：Doxygen 会生成一个名为`out`的目录，其中有HTML 格式的文档。
文档生成工具——Doxygen
⽂档⽣成⼯具——Doxygen参考： 版权声明：本⽂章转载⾃Jhuster的。
未经作者允许，严禁⽤于商业出版，否则追究法律责任。
⽹络转载请注明出处，这是对原创者的起码的尊重1 简介 为代码写注释⼀直是⼤多数程序员有些困扰的事情。
更头痛的是写⽂档，以及维护⽂档的问题，⽽doxygen就能把遵守某种格式的注释⾃动转化为对应的⽂档。
Doxygen是基于GPL的开源项⽬，是⼀个⾮常优秀的⽂档系统，当前⽀持在⼤多数unix（包括linux），windows家族，Mac系统上运⾏，完全⽀持C++, C, Java, IDL（Corba和Microsoft 家族）语⾔，部分⽀持PHP和C#语⾔，输出格式包括HTML、latex、RTF、ps、PDF、压缩的HTML和unix manpage。
有很多开源项⽬（如log4cpp和CppUnit）都使⽤了doxygen⽂档系统。
2 Doxygen配置⽂件2.1 ⽣成Doxygen配置⽂件 运⾏Doxywizard创建配置⽂件。
可以直接点“Save…”按钮，将保存默认的配置⽂件，名为Doxyfile，内容是Doxygen的默认设置。
Doxyfile是普通⽂本⽂件，可以直接打开⼿动编辑。
不过在Doxywizard的界⾯上填写也很⽅便，每个参数都有详细提⽰。
建议⽤Doxywizard 完成第⼀次设置。
以后如果需要调整个别参数，可以直接编Doxyfile。
上述Doxywizard界⾯中提供了⽣成Doxygen⽂档的4个步骤，按照上述步骤⼀步步执⾏就可以⽣成漂亮的⽂档了。
第⼀步是⽣成配置⽂件，提供三种⽅式：Wizard⽅式指简约⽅式，在其中只提供⼀些重要的参数设置，其余的均为默认值；Expert⽅式为详细设置⽅式，通过该选项可以详细地配置Doxygen的各个配置项；Load⽅式，⽤于导⼊以前⽣成的Doxygen配置⽂件，导⼊后可以再点击Expert进⾏修改。
2.2 配置选项含义详解选项含义DOXYFILE_ENCODING Doxygen⽂件的编码⽅式，默认为UTF-8，若希望⽀持中⽂，最好设置为 GB2312PROJECT_NAME Project 的名字，以⼀个单词为主，多个单词请使⽤双引号括住。
doxygen 语法
doxygen 语法Doxygen 语法简介概述：Doxygen 是一种用于生成软件文档的工具，它可以通过分析源代码中的注释来自动生成文档。
在大型项目中，良好的文档是非常重要的，因为它能够帮助开发者更好地理解和使用代码。
Doxygen 提供了一套简洁易用的语法，可以帮助开发者生成清晰、规范的文档。
注释语法：在源代码中，我们可以使用特定的注释语法来描述代码的功能、参数、返回值等信息。
下面是一些常用的注释语法示例：1. 文件注释：/*** @file filename* @brief 文件的简要描述* @details 文件的详细描述*/2. 函数注释：/*** @brief 函数的简要描述* @details 函数的详细描述* @param 参数名称参数描述 * @return 返回值描述*/3. 类注释：/*** @class ClassName* @brief 类的简要描述* @details 类的详细描述*/4. 成员变量注释：/*** @brief 成员变量的简要描述 * @details 成员变量的详细描述 */5. 枚举注释：/*** @brief 枚举类型的简要描述 * @details 枚举类型的详细描述 */6. 宏定义注释：/*** @brief 宏定义的简要描述* @details 宏定义的详细描述*/7. 文件包含注释：/*** @fileincluded*/8. 链接注释：/*** @sa function_name* @see function_name*/生成文档：使用Doxygen 生成文档非常简单，只需要按照以下步骤进行操作：1. 在源代码中添加合适的注释。
2. 创建一个配置文件，配置文件中包含一些生成文档的选项。
3. 运行 Doxygen，指定配置文件作为输入。
4. Doxygen 会根据配置文件的设置，分析源代码并生成相应的文档。
配置文件示例：下面是一个简单的配置文件示例：```PROJECT_NAME = "My Project"OUTPUT_DIRECTORY = docEXTRACT_ALL = YESEXTRACT_PRIVATE = YESEXTRACT_STATIC = YES```在这个示例中，配置文件指定了项目名称为"My Project"，生成的文档将保存在"doc" 目录下。
doxygen结构体字段注释
doxygen结构体字段注释1.简介在软件开发中，注释是非常重要的一部分。
注释能够使代码更易读、易理解、易维护，并且提供了关键信息以支持代码文档化。
do x yg en是一种流行的文档生成工具，它可以帮助开发人员生成结构化文档，并且支持多种编程语言。
本文将介绍如何使用do x yg en来注释结构体字段。
2.注释结构体字段的重要性在软件开发中，结构体用于表示一组相关的数据，并且往往具有多个字段。
注释结构体字段的作用如下：1.提供字段的详细说明：通过注释，开发人员可以清楚地了解字段的用途、类型、取值范围等信息，有助于开发人员更快地理解和使用结构体。
2.生成结构化文档：通过d ox yg en生成的文档，可以在需要的时候查看结构体字段的详细说明，方便其他开发人员阅读代码。
3.支持自动化文档生成：d ox yg en可以根据注释自动生成结构化的文档，避免了手动编写文档的繁琐工作，提高了开发效率。
3.注释结构体字段的方法在C/C++中，可以使用d ox yg en的注释格式对结构体字段进行注释。
```c/***@br ie f字段描述**字段详细说明*/i n tf ie ld;```以上示例代码中的注释采用了do xy ge n的注释格式：-`@b ri ef`：字段的简要描述。
-`字段详细说明`：字段的详细说明。
可以使用多行文字描述字段的用途、类型、取值范围等信息。
4.示例以下是一个结构体的字段注释示例：```c/***@br ie f学生信息结构体*/s t ru ct St ud en t{/***@br ie f姓名**学生的姓名。
*/c h ar na me[20];/***@br ie f年龄**学生的年龄，取值范围为[1,99]。
*/i n ta ge;/***@br ie f分数**学生的分数，取值范围为[0,100]。
*/f l oa ts co re;};```在上述示例中，通过d ox yg en的注释格式对结构体字段进行了注释。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
\extends \f$ \f[ \f] \f{ \f} \file \fn \headerfile \hideinitializer \htmlinclude \htmlonly \if \ifnot \image \implements \include \includelineno \ingroup \internal \invariant \interface \latexonly
结果为： A list of events: mouse events mouse move event mouse click event More info about the click event. mouse double click event keyboard events key down event key up event More text here.
@param
@return
@retval
描述返回值类型 eg: @retval NULL 空字符串。 @retval !NULL 非空字符串。
注解 注意
@note @attention
@warning
@enum
警告信息
引用了某个枚举，Doxygen会 在该枚举处产生一个链接 eg： @enum CTest::MyEnum
\skip \skipline \struct \subpage \subsection \subsubsection \test \throw \throws \todo \tparam \typedef \union \until \var \verbatim \verbinclude \version \warning \weakgroup \xmlonly \xrefitem \$ \@
\li \line \link \mainpage \manonly \memberof \msc \mscfile \n \name \namespace \nosubgrouping \note \overload \p \package \page \par \paragraph \param \post \pre \private
6. 项目符号标记 /* * A list of events: * – mouse events * -# mouse move event * -# mouse click event\n * More info about the click event. * -# mouse double click event * – keyboard events * -# key down event * -# key up event * * More text here. */
\privatesection \property \protected \protectedsection \protocol \public \publicsection \ref \related \relates \relatedalso \relatesalso \remark \remarks \result \return \returns \retval \rtfonly \sa \section \see \short
4. 函数说明 /* * 简要的函数说明文字 * @param [in] param1 参数1说明 * @param [out] param2 参数2说明 * @return 返回值说明 */ int func(int param1, int param2);
/* * 打开文件 \n * 文件打开成功后，必须使用 ::CloseFile 函数关闭。 * @param[in] file_name 文件名字符串 * @param[in] file_mode 文件打开模式字符串，可以由以下几个模块组合而成： * – r 读取 * – w 可写 * – a 添加 * – t 文本模式(不能与 b 联用) * – b 二进制模式(不能与 t 联用) * @return 返回文件编号 * – -1 表示打开文件失败 * @note 文件打开成功后，必须使用 ::CloseFile 函数关闭 * @par 示例: * @code // 用文本只读方式打开文件 int f = OpenFile(”d:\\test.txt”, “rt”); * @endcode * @see ::ReadFile ::WriteFile ::CloseFile * @deprecated 由于特殊的原因，这个函数可能会在将来的版本中取消。 */ int OpenFile(const char* file_name, const char* file_mode);
下面是手册上列出的指令
\a \addindex \addtogroup \anchor \arg \attention \author \authors \b \brief \bug \c \callgraph \callergraph \category \class \code \cond \copybrief \copydetails \copydoc \date \def \defgroup \deprecated
@var
@class
@exception
引用了某个变量，Doxygen会 在该枚举处产生一个链接 eg： @var CTest::m_FileKey 引用某个类， 格式：@class <name> [<header-file>] [<header-name>] eg: @class CTest "inc/class.h" 可能产生的异常描述 eg: @exception 本函数执行可能 会产生超出范围的异常
Q:输出中文乱码 A:修改输入编码方式 INPUT_ENCODING = GB2312
5. 枚举类型定义 /** 枚举常量 */ typedef enum TDayOfWeek { SUN = 0, /**< 星期天（注意，要以 “<” 小于号开头） */ MON = 1, /**< 星期一 */ TUE = 2, /**< 星期二 */ WED = 3, /**< 星期三 */ THU = 4, /**< 星期四 */ FRI = 5, /**< 星期五 */ SAT = 6 /**< 星期六 */ } /** 定义类型 TEnumDayOfWeek */ TEnumDayOfWeek;
以上两种风格间的*是可选的。
第三种是使用至少两行C++"//"注释，如： /// 或者 //! /// ... 文本... //!...文本... /// //!
此外，对于上面格式的注释，Doxygen是 认为在解释后面的程序代码，如果要注释 前面的程序代码，需要使用下面的格式。
/**< ... 注释 ... */ /*!< ... 注释 ... */ //!< ... 注释 ...
5. Structural indicators（结构标示） \addtogroup <name> [(title)] 增加一个组类似于\defgroup \callgraph 为函数产生图表，需要HAVE_DOT is set to YES \class <name> [<header-file>] [<header-name>] \dir [<path fragment>] \def <name> \defgroup <name> (group title) \enum <name> \file [<name>] \internal \mainpage [(title)] \namespace <name>
\\ \& \~ \< \> \# \% \" \\::
这些指令可分以下几类：
1. Section indicators （区域标示） \author \brief \details \param [(dir)] <parameter-name> { parameter description } \return \see \warning \bug 2. Commands to create links （建立连接指令） \anchor <word> \link <link-object> 3. Commands for displaying examples \include <file-name> \skip 4. Commands for visual enhancements （提高可视化的指令） \a <word> \b <word>
\details \dir \dontinclude \dot \dotfile \e \else \elseif \em \endcode \endcond \enddot \endhtmlonly \endif \endinternal \endlatexonly \endlink \endmanonly \endmsc \endrtfonly \endverbatim \endxmlonly \enum \example \exception
配置好后，在目录下输入命令doxygen Doxyfile，以完成配置。
二.注释 doxygen配置完，就可以根据含有正确 注释格式的代码生成文档里。格式主要 包含三种：
可以使用JAVADoc风 格，类似于由C风格的 注释块： /** * ... 文本 ... */ 此外也可以使用Qt风 格，如： /*! * ... 文本... */
三. 指令说明：
@file @author @brief 档案的批注说明。 作者的信息 用于class 或function的简易说 明 eg： @brief 本函数负责打印错误 信息串 主要用于函数说明中，后面 接参数的名字，然后再接关 于该参数的说明 描述该函数的返回值情况 eg: @return 本函数返回执行结 果，若成功则返回TRUE，否 则返回FLASE