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

未经作者允许，严禁⽤于商业出版，否则追究法律责任。

⽹络转载请注明出处，这是对原创者的起码的尊重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的注释格式对结构体字段进行了注释。

DOXYGEN代码文档生成工具的使用

DOXYGEN代码文档生成工具的使用
一、Doxygen介绍
Doxygen是一种使用C++编写的自由、开源的文档编译器，用于基于
源代码的文档生成。

Doxygen可以用来生成多种不同的文档格式，如HTML、LaTeX、PDF、PostScript、Man和RTF，可以自带功能，同时可以输出各
种类图、流程图、以及无数其他图表来帮助说明意图和定义。

二、Doxygen使用
Doxygen的配置文件是一个可在配置文件中设置不同参数的文本文件。

用户可以在其中设置不同的文档输出格式、文件类型、源文件路径、源文
件编码格式、对表达式的评估等参数，以控制Doxygen的输出文档。

Doxygen可以根据代码中的注释来生成文档，因此，要想使用Doxygen生成文档，代码中需要有完整的注释，包括文件简介、变量注释、函数注释和类注释等。

Doxygen主要由以下几部分组成：
（1）标准文档：由Doxygen管理的文档，用户可以在其中添加自己
的文档。

（2）源文件：存放源代码的文件夹，以及文件。

使用Doxygen构建文档系统

使用Doxygen构建文档系统如果您这次还没来得及使用老式的Help Workshop为您的Web 应用构建文档系统的话那么何不尝试一下Doxygen 需知 The proof of the pudding lies in the eatingDoxygen是什么？Doxygen是一种开源跨平台的以类似JavaDoc风格描述的文档系统完全支持C C++ Java Objective C和IDL语言部分支持PHP C# 注释的语法与Qt Doc KDoc和JavaDoc兼容Doxgen可以从一套归档源文件开始生成HTML格式的在线类浏览器或离线的LATEX RTF 参考手册对于未归档的源文件也可以通过配置Doxygen来提取代码结构或者借助自动生成的包含依赖图（include dependency graphs）继承图（inheritance diagram）以及协作图（collaboration diagram）来可视化文档之间的关系 Doxygen生成的帮助文档的格式可以是CHM RTF PostScript PDF HTML和Unix man page等Doxygen在Linux上开发但也可以在其它的Unix平台下运行而且 Windows x/NT平台下也有对应的可执行版本安装Doxygen首先去Doxygen网站上找到最新版本的Doxygen 有二进制或源码两种版本如果不想重头编译下载二进制版本安装即可在Linux下源码编译需要perl和Gnu工具flex bison make的支持在Windows 下二进制版本勿需安装而源码编译所需支持工具较多我们仅讲述Linux下的Doxygen的源码编译以及二进制版本安装过程编译源码gunzip doxygen $VERSION src tar gz tar xf doxygen $VERSION src tar sh /configure 或者configure platform platform type （略去直接使用configure需要平台检测的过程平台类型在PLATFORMS文件中列出）configure with doxywizard（GUI前端选项） make 或者make docs（创建HTML格式的手册） make pdf （创建PDF格式的手册）安装二进制版本/configure make install二进制文件安装目录是<prefix>/bin 其中<prefix>缺省为/usr 可以通过configure的参数 prefix修改其值使用make install_docs可以把文档和例子安装在目录<docdir>/doxygen 其中<docdir>缺省为<prefix>/share/doc/packages 可以通过configure的参数 docdir 修改其值 doxygen是bin目录下的一个命令行程序它是Doxygen的核心工具完成文档的转换和生成工作Doxygen的处理流程图是Doxygen网站上给出的Doxygen处理工具以及它们之间的信息流从图中可以看出Doxygen可执行程序位于正中所有的流程都围绕着它进行左侧图标表示Doxygen的输入可以是源文件或者是定制的头文件图像注解等 Doxygen图标上部是配置文件由Doxywizard 处理下部是Tag文件由Doxytag处理后面是Doxygen输出文件的类型依次是XML Latex Man pages RTF和HTML 可处理类型图标之后是进行进一步转换所需的工具图 Doxygen网站上给出的Doxygen信息流图配置文件每一个Doxygen工程都有一个后缀为cfg的配置文件用来保存所有的设置配置文件的格式与autoexec bat config sys等文件相似是由名称/值对组成的ASCII码会由doxygen命令来解析为了简化创建和修改配置文件 Doxygen可以在命令行方式下加上参数 g自动创建模板文件doxygen g <config file>忽略<config file>将会生成一个名为Doxyfile的缺省文件如果<config file>已经存在会被Doxygen改名为<config file> bak 实际上我们根本就不需要用一般的编辑器来编辑配置文件Doxygen提供了一个辅助工具Doxywizard Doxywizard是Doxygen的GUI前台用户可以能过它来读写配置文件省却了手工配置的麻烦基本上在Doxywizard中可以完成Doxygen的绝大多数工作而且Doxygen也可以在由Doxywizard启动这样就使得整个过程比较连贯虽然如此我们还是要理解常见的各个T ag的含义在Doxywizard 中可以看到这些Tag以自明的方式命名我们大致可以从名称中看出其作用这些Tag被Doxywizard大致分为几类其中HTML到PerlMod 是输出文件种类设置 Project是Doxygen工程设置 Build是编译类选项 Messages为出错或异常选项 Input为输入源选项等等图 Doxywizard注释Doxygen规定了进行注释的一些格式正确的注释才能使Doxygen生成文档第一个代码条目都有两种描述简要描述和详细描述两者都是可选的简要描述只有一行而详细描述则提供更长更仔细的描述 Doxygen只允许有一个简要描述和详细描述在Doxygen中一般只会处理与程序结构相关的注释函数内部的注释通常不做处理对于详细描述来说有下面几种表示方式JavaDoc风格中间的 * 号可选 /** * 注释 */ Qt风格中间的 * 号可选 /*! * 注释 */ C++风格的变体或者最后一个 / 改为！也可以 /// 单行注释/// 注释/// 更加显著的表示/////////////////////////////////////////// /// 注释/////////////////////////////////////////// 简要描述亦有多种表示方式在上述注释块中使用\brief命令详细注释在空行之后开始 /*! \brief 简要描述 * 继续 * * 详细注释 */ JAVADOC_AUTOBRIEF设置为YES后在JavaDoc风格的注释中第一个点号之前的内容被自动设置为简要描述对于多行C++变体这个选项亦会起到相同的作用 /** 简要描述详细描述 * 注释 */ C++变体风格 /// 简要描述 /* 详细描述 */ 命令Doxygen支持的指令非常多主要作用是控制输出文档的排版格式命令以 \ 或 @ 号开始一些命令可以有多个参数一些命令只有一个参数参数周围的括号使用是有含义的<>号表示参数是单个词()号表示参数一直会到行尾{}号表示参数会扩展到下一段落 []号表示参数是可选的下面章节中也涉及到一些命令的使用其它的命令可以查阅Doxygen用户手册列表Doxygen有许多 ... 可以创建项目列表使用在每行开始之前打头使用可以结束一个列表开始新的段落使用这种 ... 要严格对齐 /** * 表项一 * 子项一 * 子项二 * * */ 在文档块中使用HTML命令这种 ... 不需要严格对齐 /*! * <ul> * <li> 表项一 * <ol> * <li> 子项一 * <li> 子项二 * </ol> * <li> 表项二 * </ul> */ 分组Doxygen有两种分组机制第一种是全局地为每一个组创建一个网页此时分组被称为 module 第二种是用于复合实体中的成员列表此时分组被称为 member group Module是一种把内容在单个网页上分组的 ... 分组可以包括files namespace classes functions variables enums typedefs和defines 也可以包含其它分组复合实体（pound entities）如类文件命名空间等可以分布在多个分组中而成员实体（member）如变量函数 typedef等只能归属于一个分组定义分组的... 是在特殊注释块中使用命令\defgroup和\addtogroup defgroup的格式如下\defgroup <唯一标识名> （中间可以有空格的标题）两次使用同一标识名在doxygen解析的时候会出现错误命令addtogroup与defgroup不同的地方在于如果使用了同一标识则会在改组中加入新的项如果标识不重复则会创建分组 addtogroup中的标题是可选的声明分组之后如果要使某个实体归属某一分组需要使用ingroup 命令避免在每个成员之前都使用ingroup命令可以将member用@{和@}封装起来/** * \ingroup A */ extern int VarInA; /** * \defgroup IntVariables Global integer variables */ /*@{*/ /** an integer variable */ extern int IntegerVariable; /*@}*/ /** * \defgroup Variables Global variables */ /*@{*/ /** a variable in group A */ int VarInA; int IntegerVariable; /*@}*/上面这些命令都是有优先级的 doxygen会根据优先级将实体放入具有最高优先级的分组之中它们的优先级顺序是ingroup defgroup addtogroup weakgroup weakgroup类似一个低优先级的addtogroup 在 h文件中可以使用高优先级的命令定义层次结构在 c 文件中\weakgroup就不需要准确遵循 h文件中定义的层次结构如果要把不同的类型归入同一分组内就要使用Member group 它的定义 ... 如下//@{ //@} 或者 /*@{*/ /*@}*/Member group不可以嵌套图表Doxygen里有内置生成C++类层次图的功能它使用贝尔实验室开发的graphviz 中的工具dot 来生成更高级的图表使用这个工具时要将配置选项HAVE_DOT设为YES当GRAPHICAL_HIERARCHY设置为YES时将会绘制一个图形表示的类图结构当CLASS_GRAPH设置为YES时会为每个归档的类创建一张图表示其直接或间接的继承关系当INCLUDE_GRAPH设置为YES时会为每个归档文件创建一幅包含依赖图此功能目前仅有HTML 和RTF格式支持当COLLABORATION_GRAPH设置为YES时会为每个归档类或结构绘制基类继承关系图和使用关系图当CALL_GRAPH 设置为YES时会为每个函数显示一幅直接或间接调用关系图更具体的信息可以参考Doxygen的手册公式Doxygen可以把LaTeX格式的公式输出出来要在HTML文档里包含公式需要安装下面的工具 latex（LaTeX编译器） dvips（将DVI 文件转换为PS文件） gs（将PS文件转换为位图）包含公式的 ... 有两种使用\f$命令对表示文本中间的公式遵循LaTeX格式\f$(x_ y_ )\f$ (x y ) 位于独立一行上未编号的公式应放在命令\f[和\f]之间\f[ |I_ |=\left| \psi(t) \right| \f] 对应的输出是|I |=|ψ(t)|中文文档Doxygen支持多种语言输出中文文档的时候只需要将配置文件中的OUTPUT_LANGUAGE标签设置为Chinese即可（用Doxywizard修改更方便）有一个需要注意的问题是在Windows下的浏览器浏览中文HTML文档时英文字母会变得很难看解决的办法是将doxygen_cn css下载到本地硬盘并将配置文件中的HTML_STYLESHEET修改为这个文件的位置HTML_STYLESHEET=c:\doxygen\doxygen css运行doxygen在命令行下运行doxygen是很简单的只需要指定配置文件即可doxygen project cfg或者也可以使用Doxywizard在配置完后直接运行doxygenlishixinzhi/Article/program/Java/hx/201311/26448。

doxygen使用方法

doxygen使用方法Doxygen是一个开源工具，用于生成软件项目的文档。

它可以解析源代码中的注释，然后生成相应的文档，包括类、函数、变量、文件等的说明，以及函数的调用图、继承图等。

本文将详细介绍Doxygen的使用方法。

一、安装Doxygen二、配置Doxygen在使用Doxygen生成文档之前，需要进行一些配置。

Doxygen的配置文件为'Doxyfile'，通过修改这个文件来定制Doxygen的行为。

1.在项目根目录下，使用以下命令生成默认的配置文件：``````一些常用的参数如下：-PROJECT_NAME：项目的名称，会显示在生成的文档中。

-INPUT：需要生成文档的源文件或目录。

通常设置为代码文件所在的目录，以及一些额外的源文件。

-OUTPUT_DIRECTORY：文档的输出目录。

-RECURSIVE：是否递归处理子目录。

-FILE_PATTERNS：需要处理的源文件的模式。

可以使用通配符指定多个文件类型。

-EXCLUDE：需要排除的文件或目录。

3.保存修改后的配置文件。

4.使用以下命令来生成文档：``````5. 生成的文档将存储在指定的输出目录中。

打开'index.html'文件即可浏览生成的文档。

三、编写注释为了让Doxygen能够正确解析源代码中的注释并生成相应的文档，我们需要按照一定的规则编写注释。

下面是一些常用的注释标记和使用方法。

1.文件注释```/***...*/```2.命名空间注释```/***...namespace namespace_name//...```3.类注释```/***...*/class class_name//...```4.函数注释```/***...*/return_type function_name(param_type param_name) //...四、生成高级文档特性Doxygen还支持生成一些高级的文档特性，如调用图、继承图等。

代码注释规范之Doxygen

代码注释规范之Doxygen1.Doxygen简介Doxygen是⼀个程序的⽂档产⽣⼯具，可以将程序中的注释转换成说明⽂档或者说是API参考⼿册，从⽽减少程序员整理⽂档的时间。

当然这⾥程序中的注释需要遵循⼀定的规则书写，才能让Doxygen识别和转化。

⽬前Doxygen可处理的程序语⾔包含C/C++、Java、Objective-C、IDL等，可产⽣出来的⽂档格式有HTML、XML、LaTeX、RTF等，此外还可衍⽣出不少其它格式，如HTML可以打包成CHM格式，⽽LaTeX可以通过⼀些⼯具产⽣出PS或是PDF⽂档等。

2.2.Doxygen安装及使⽤安装列表：Doxygen：下载地址，HTML Help：微软官⽅⽤于⽣成HTML格式的help⽂件，下载地址，Graphviz：⼀种dot⼯具可以⽤来渲染出效果更好的图表，下载地址，windows上安装很简单，⽆需特别设置。

2.1 Doxygen设置1.向导2.专家设置2.1 Project每个配置项均有详细⿏标放置时均有详细注释，以下是我的设置可供参考，特别注意语⾔，避免中⽂乱码2.2 BuildEXTRACT_ALL 表⽰：输出所有的函数，但是private和static函数不属于其管制。

EXTRACT_PRIVATE 表⽰：输出private函数。

EXTRACT_STATIC 表⽰：输出static函数。

同时还有⼏个EXTRACT，相应查看⽂档即可。

HIDE_UNDOC_MEMBERS表⽰：那些没有使⽤doxygen格式描述的⽂档（函数或类等）就不显⽰了。

当然，如果EXTRACT_ALL被启⽤，那么这个标志其实是被忽略的。

INTERNAL_DOCS 主要指：是否输出注解中的@internal部分。

如果没有被启动，那么注解中所有的@internal部分都将在⽬标帮助中不可见。

CASE_SENSE_NAMES 表⽰：是否关注⼤⼩写名称，注意，如果开启了，那么所有的名称都将被⼩写。

一款常用文档生成工具：Doxygen

一款常用文档生成工具：Doxygen程序员的很多文档，特别是有代码的文档，绝大部分都是由一款文档生成工具【Doxygen】生成。

什么是Doxygen?Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。

通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。

大部分有用的批注都是属于针对函式，类别等等的说明。

所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用你的程序代码的人而言将会减少许多的负担。

不过，反过来说，整理文件的工作对于你来说，就是沉重的负担。

简而言之，Doxgen就是大名鼎鼎的文档生成工具，而且是免费开源的，它使用非常方便，能提取C++，Java，Objective-C，Python，IDL，PHP，C#等语言的注释，从而生成文档。

Doxygen 的使用可分为两大部分。

首先是特定格式的批注撰写，第二便是利用Doxygen的工具来生成文档。

生成文档使用教程1、安装在Linux下可以通过apt install doxygen安装命令行工具，然后用apt install doxygen-gui安装图形界面。

对Linux用户来说，命令行工具可以通过doxygen命令运行，而图形界面可以通过doxywizard命令运行。

Windows 用户的下载地址：/download.html2、基本使用图形工具的基本使用如下图所示，有非常多的配置选项，这里我们只填入必要的配置，其它配置都用默认值。

doxywizard使用步骤doxywizard使用步骤工作目录如下：.├── out└── src└── math.h其中math.h代码如下：/*! \file math.h *//*!用于求一个角度的sin值，输入是字符串以便同时支持弧度制和角度制表示\li 弧度制用pi表示，例如：2pi表示一圈、0.5pi表示直角\li 角度制用d结尾，例如：360d表示一圈、90d表示直角\li 输入也可以是数值，例如：输入3.14159大约表示180度\param a 用弧度制或角度制表示都行，字符串必须用'\0'表示结束\param[out] res 是输出参数，用于保存sin运算的结果\return 错误码，0表示成功，其它表示失败\todo 在xxx的情况下存在BUG，预计下一版本修复*/int sin(char *a, double *res);Doxygen生成的HTML会放到out目录下，生成的HTML如下图所示。

doxygen源码编译

doxygen源码编译
Doxygen 是一个用于生成代码文档的工具，它可以从源代码中提取注释和结构信息，并生成 HTML、LaTeX、PDF 等格式的文档。

如果你想要从源码编译 Doxygen，可以按照以下步骤进行操作：
1. 下载 Doxygen 源码
可以从 Doxygen 的官方网站或者 GitHub 上下载源码包。

下载完成后，解压源码包，进入源码目录。

2. 配置编译环境
Doxygen 需要 C++ 编译器和 Qt 库来编译。

你需要先安装这些依赖项。

在 Ubuntu 上，可以使用以下命令安装：
```bash
sudo apt-get install build-essential libqt5core5a libqt5gui5 libqt5widgets5
```
3. 编译 Doxygen
在源码目录下，运行以下命令进行编译：
```bash
qmake
make
```
如果一切顺利，编译过程将在当前目录下生成 Doxygen 可执行文件。

4. 运行 Doxygen
在编译完成后，你可以在源码目录下找到 Doxygen 可执行文件。

运行以下命令启动 Doxygen：
```bash
./doxygen
```
Doxygen 将读取配置文件并生成文档。

生成的文档将保存在一个名为"html" 的目录中。

你可以在浏览器中打开该目录以查看生成的文档。

doxygen 设计原理

doxygen 设计原理
Doxygen是一种自动化文档生成工具，它可以从源代码中提取注释和代码结构信息，生成各种格式的文档，如HTML、PDF、LaTeX等。

其设计原理主要包括以下几个方面：
注释格式：Doxygen支持多种注释格式，如C++、Java、Python 等，可以根据不同的语言自动识别注释，并将其转换为文档。

代码结构分析：Doxygen可以分析源代码的结构，包括类、函数、变量等，可以根据代码结构生成文档的目录结构。

交叉引用：Doxygen可以自动识别代码中的函数、变量等，并在文档中进行交叉引用，方便用户查看相关信息。

多种输出格式：Doxygen支持多种输出格式，如HTML、PDF、LaTeX等，用户可以根据需要选择不同的输出格式。

自定义配置：Doxygen提供了丰富的配置选项，用户可以根据自己的需求进行配置，如文档样式、目录结构、交叉引用等。

总之，Doxygen的设计原理是基于源代码的注释和结构信息，
通过分析和转换，生成各种格式的文档，方便用户查看和使用。

doxygen的注释风格

doxygen的注释风格Doxygen的注释风格是一种用于代码文档化的注释风格。

通过使用Doxygen的注释风格，开发人员可以在代码中添加注释，从而生成具有可读性和易于理解的代码文档。

在使用Doxygen注释风格时，一些常用的注释标记和用法包括：1. 文件注释：在代码文件的开头，使用`/**`和`*/`将注释内容包围起来，用于描述整个文件的概要信息。

可以包括作者、日期、文件用途等相关信息。

2. 函数注释：在函数的定义前，使用`/**`和`*/`将注释内容包围起来，用于描述函数的功能、参数、返回值等详细信息。

可以使用标记如`@param`和`@return`来说明参数和返回值的含义。

3. 类注释：在类的定义前，使用`/**`和`*/`将注释内容包围起来，用于描述类的功能、成员变量、成员函数等详细信息。

可以使用标记如`@brief`、`@param`和`@return`来说明类的概要信息、参数和返回值的含义。

4. 成员变量注释：在类的成员变量前，使用`//!`或`///<`来注释成员变量的含义和用途。

5. 枚举注释：在枚举类型的定义前，使用`/**`和`*/`将注释内容包围起来，用于描述枚举类型的含义和取值范围。

通过使用Doxygen的注释风格，开发人员可以轻松地生成代码文档。

Doxygen会解析这些注释，并将其转换为可供阅读的HTML、PDF或其他格式的文档。

开发人员可以根据需要自定义文档的格式和样式。

使用Doxygen注释风格的好处是显而易见的。

首先，它可以提高代码的可读性和可维护性。

通过在代码中添加详细的注释，其他开发人员可以更容易地理解代码的功能和用法。

其次，生成的代码文档可以作为代码的说明文档，供用户参考和使用。

最后，代码文档可以帮助开发人员更好地组织和管理代码，提高开发效率。

然而，使用Doxygen注释风格也需要注意一些问题。

首先，注释的内容应准确、严谨，避免歧义或错误信息的出现。

doxygen 数学公式

doxygen 数学公式Doxygen 是一种自动文档生成工具，主要用于生成代码的文档。

虽然Doxygen 不是一个数学公式编辑器，但它支持一些简单的数学公式，并可以集成LaTeX 公式。

下面是如何在Doxygen 中使用数学公式的简要指南：一、使用MathJax 渲染数学公式Doxygen 支持使用MathJax 渲染数学公式。

你可以在Doxygen 注释中使用MathJax 标记语法。

1.1 在Doxygen 注释中启用MathJax 支持：在Doxygen 配置文件中，设置USE_MATHJAX 选项为YES。

# Doxyfile# Enable MathJax supportUSE_MATHJAX =YES1.2 在注释中插入数学公式：在注释中，你可以使用MathJax 的\[ ... \] 或$$ ... $$ 包裹数学公式。

/*** @brief计算平方根** 使用MathJax 渲染数学公式：* \[* \sqrt{x}* \]** @param x要计算平方根的数* @return平方根*/double calculateSquareRoot(double x);1.3 生成文档：使用Doxygen 命令生成文档：doxygen Doxyfile1.4 在生成的HTML 文档中查看数学公式：打开生成的HTML 文档，在浏览器中MathJax 会渲染数学公式。

二、使用LaTeX 公式Doxygen 还支持使用LaTeX 公式，但在配置文件中启用MathJax 时，LaTeX 公式将被MathJax 渲染。

2.1 在注释中插入LaTeX 公式：在注释中，你可以使用@f$ ... @f$ 或@f[ ... @f] 包裹LaTeX 公式。

/*** @brief计算平方根** 使用LaTeX 公式：* @f[* \sqrt{x}* @f]** @param x要计算平方根的数* @return平方根*/double calculateSquareRoot(double x);2.2 生成文档：使用Doxygen 命令生成文档：doxygen Doxyfile2.3 在生成的HTML 文档中查看数学公式：打开生成的HTML 文档，MathJax 将渲染LaTeX 公式。

doxygen介绍

doxygen介绍Doxygen1 简介Doxygen是一种开源跨平台的，以类似Java Doc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。

注释的语法与Qt-Doc、KDoc和JavaDoc 兼容。

Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

2 使用步骤由于只是工具的使用，这里不介绍它的原理，直接从使用步骤开始。

Doxygen的使用步骤非常简单。

主要可以分为：1）第一次使用需要安装doxygen的程序2）生成doxygen配置文件3）编码时，按照某种格式编写注释4）生成对应文档doxygen的安装非常简单，linux下可以直接下载安装包运行即可，下载源代码编译安装也是比较通用的编译安装命令。

Doxygen在生成文档时可以定义项目属性以及文档生成过程中的很多选项，使用下面命令能够产生一个缺省的配置文件：doxygen -g config.ini可以根据项目的具体需求修改配置文件中对应的项，具体的修改过程在下面介绍。

修改过的配置文件可以作为以后项目的模板。

让doxygen自动产生文档，平常的注释风格可不行，需要遵循doxygen自己的格式。

具体如何写doxygen认识的注释等哈详细介绍。

当代码编完了，注释也按照格式写好了，，运行下面的命令，相应的文档就会产生在指定的目录中(和配置文件的同一目录下的doc文件夹中，都成文件夹中又有3各文件夹(html(也是构成网页文档的主要语言),latex（一种基于TeX的排版系统）,rtf（以纯文本描述内容）))。

doxygen config.ini需要注意的是doxygen并不处理所有的注释，doxygen重点关注与程序结构有关的注释，比如：文件、类、结构、函数、变量、宏等注释，而忽略函数内变量、代码等的注释。

3 C++中具体用法文件的注释：/*! \file license.h\brief license处理函数API头文件.详细描述……*/函数的注释：/*! \fn int GenDevInfo(u8 *sOutFileName, u8 *sUpKeyFileName, u8 *sDevInfoFileName, u32 uLastLicId) \brief 获取设备lic请求信息.\param sOutFileName 生成的请求文件存放路径及名字.\param sUpKeyFileName key文件路径.\param sDevInfoFileName 设备编号dev_no存放路径.\param uLastLicId 上一次导入的licID编号.\retval 0 成功\retval 非0 失败*/类的注释：//! A test class./*!A more elaborate class description.*/class Test{public:/** An enum type.* The documentation block cannot be put after the enum! */enum EnumType{int EVal1, /**< enum value 1 */int EVal2 /**< enum value 2 */};void member(); //!< a member function.protected:int value; /*!< an integer value */}//! class variable./*! Details. */s1,//! class variable./*! Details. */s2;结构体的注释：//! A tt struct./*!A more elaborate class description.*/typedef struct _gwchklic_encinfo{u32 dwBeginTime; /*!< an u32 value */}//! struct variable./*! Details. */GWCHKLIC_ENCINFO,//! struct pointer./*! Details. */*PGWCHKLIC_ENCINFO;宏的注释：/*! \def FUNCMAP\brief A macro that rrrrrrrrrrrrrrr.Details.*/#define FUNCMAP 0全局和静态变量：//! variable./*! Details. */static int test = 0;//! variable./*! Details. */int test1 = 0;4 文档的生成前的配置修改config.ini中选项（主要几个选项）PROJECT_NAME = lonsin ：首页显示名字为lonsinOUTPUT_LANGUAGE = Chinese或English ：输出中文或英文FULL_PATH_NAMES = NO ：是否要显示全路径的文件名SHOW_INCLUDE_FILES = NO ：是否显示包含的头文件INPUT = include/license.h ：可以是文件也可以是文件夹INPUT_ENCODING = GB18030 ：输入的中文字体（UTF-8 GB18030）FILE_PATTERNS = *.cpp ：输入文件的样式(*.c *.h ……) EXCLUDE_SYMLINKS = YES ：显示时排除连接或宏EXTRACT_STATIC=NO：是否包含静态变量EXTRACT_PRIVATE=NO：是否显示私有成员。

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