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风格注释代码⽣成⽂档⽤doxygen风格注释代码⽣成⽂档⽬录1. 说明⽬前由代码⽣成⽂档的⽅式将使项⽬变得简单，同时⽣成的⽂档也会将与代码同步起来。

要注意⽂档的规范性，所以可以采⽤doxygen⾃动⽣成⽂档。

下⾯通过操作对⽂档的注释进⾏⼀下总结。

2. 具体操作因为我们⽤的vscode的，可以下载Doxygen Documentation Generator插件。

当安装上插件后可以进⾏使⽤了。

2.1 ⽣成头部注释⽣成头部注释很简单便会⾃动出现下⾯的注释注释函数我们也可以采⽤这种⽅式/*** @file testdoxygen.c* @author your name (you@)* @brief* @version 0.1* @date 2019-01-23** @copyright Copyright (c) 2019**/#include "stdio.h"/*** @brief 测试⽂件1**/void test1(void){}/*** @brief 测试第⼆个例⼦** @param a* @param b* @return int*/int test2(int a,int b){return a+b;}/*** @brief 测试第三个例⼦** @return true* @return false*/bool test3(void){return false;}该代码编写完成后就可以⽤doxygen⽣成代码说明了。

2.2 安装doxygen下载链接：下载完成就可以点击安装了，下⼀步，下⼀步直接安装，安装完成就可以直接打开进⾏查看。

2.3 ⼯程配置打开后就可以配置⼯程了设置代码抽取及优化模式设置输⼊设置配图⽅案⽣成⽂档⽣成后可以看到html⽂件夹和rtf⽂件夹打开html⽂件夹进⼊index.html这样就⽣成了⼯程代码的描述⽂档。

3. 总结写代码的时候⼀定要规范，所以在写代码的过程中，⼀定需要添加注释，按照doxygen风格⽣成的注释，可以给他⼈查阅，并且调⽤相关的api即可进⾏使⽤。

linux vscode doxygen documentation generator 用法

linux vscode doxygen documentation generator 用法要在Linux上使用VSCode和Doxygen生成文档，您需要按照以下步骤进行操作：安装VSCode：首先，您需要在Linux上安装Visual Studio Code。

您可以从VSCode 官网下载适用于Linux的安装程序，并按照说明进行安装。

安装Doxygen：Doxygen是一个用于生成代码文档的工具。

您可以使用包管理器来安装Doxygen。

例如，在Ubuntu上，您可以使用以下命令安装Doxygen：sqlsudo apt-get install doxygen安装Doxygen插件：在VSCode中，您需要安装Doxygen插件来支持Doxygen文档生成。

打开VSCode，进入扩展商店，搜索Doxygen并安装它。

配置Doxygen：在VSCode中打开您的项目文件夹，并打开名为"Doxyfile"的文件（如果不存在，您可以创建一个）。

在Doxyfile中，您可以配置Doxygen的选项，例如输出格式、目录结构和生成器类型等。

生成文档：配置完成后，打开终端并导航到项目文件夹。

运行以下命令来生成文档：cssdoxygen Doxyfile这将根据Doxyfile中的配置生成文档。

6. 查看文档：生成的文档将保存在指定的输出目录中。

您可以在浏览器中打开生成的HTML文件来查看文档。

请注意，以上步骤是一般性的指导，具体细节可能因您的项目和配置而有所不同。

确保仔细阅读Doxygen和VSCode的文档，并根据您的需求进行适当的配置和调整。

文档生成工具——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 的名字，以⼀个单词为主，多个单词请使⽤双引号括住。

linuxdoxygen使用说明

linuxdoxygen使用说明目录1.安装doxygen (2)2.配置Doxygen工作环境 (2)3.程序源码文档化 (3)4.程序文档生成 (4)5.Doygen 集成到codeBlocks (4)5.1配置步骤 (4)5.2使用： (4)1. 安装doxygen安装包doxygen-1.7.4.linux.bin.tar.gz命令：1)tar xvfz doxygen-1.7.4.linux.bin.tar.gz2)cd doxygen-1.7.43)./configure4)make5)make install安装后需留意下doxyg的路径，例如：/usr/bin/doxygen2. 配置Doxygen工作环境步骤：6)进入项目目录（test为例说明）cd test/7)生成配置文件Doxygen –g●默认生成的配置文件名为"Doxyfile"，也可以采用"doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。

如无特殊需要，采用默认的配置文件名即可。

●Doxyfile 文件内容非常多，大概1000 多行，不过其中约4/5 都是注释，每个配置选项都有一段详细的注释。

日后，如果对Doxygen 各配置选项的意义有一定了解，可以在生成配置文件的命令中添加"-s"选项，生成不含注释的配置文件，操作如下：$ doxygen -s -g3）配置文件的相应设置，这里已经有个模板Doxyfile(test文件夹下)，可以根据需要更改相应设置# 项目名称，将作为于所生成的程序文档首页标题PROJECT_NAME = “Test# 文档版本号，可对应于项目版本号，譬如svn、cvs 所生成的项目版本号PROJECT_NUMBER = "1.0.0# 程序文档输出目录OUTPUT_DIRECTORY = doc/# 程序文档语言环境OUTPUT_LANGUAGE = Chinese# 如果是制作C 程序文档，该选项必须设为YES，否则默认生成C++ 文档格式OPTIMIZE_OUTPUT_FOR_C = YES# 对于使用typedef 定义的结构体、枚举、联合等数据类型，只按照typedef 定义的类型名进行文档化TYPEDEF_HIDES_STRUCT = YES# 在C++ 程序文档中，该值可以设置为NO，而在C 程序文档中，由于C 语言没有所谓的域/名字空间这样的概念，所以此处设置为YES HIDE_SCOPE_NAMES = YES# 让doxygen 静悄悄地为你生成文档，只有出现警告或错误时，才在终端输出提示信息QUIET = YES# 只对头文件中的文档化信息生成程序文档FILE_PATTERNS = *.h# 递归遍历当前目录的子目录，寻找被文档化的程序源文件RECURSIVE = YES# 示例程序目录EXAMPLE_PATH = example/# 示例程序的头文档(.h 文件) 与实现文档(.c 文件) 都作为程序文档化对象EXAMPLE_PATTERNS = *.c \*.h# 递归遍历示例程序目录的子目录，寻找被文档化的程序源文件EXAMPLE_RECURSIVE = YES# 允许程序文档中显示本文档化的函数相互调用关系REFERENCED_BY_RELATION = YESREFERENCES_RELATION = YESREFERENCES_LINK_SOURCE = YES# 不生成latex 格式的程序文档GENERATE_LATEX = NO# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了graphviz 软件包HAVE_DOT = YESCALL_GRAPH = YESCALLER_GRAPH = YES#让doxygen从配置文件所在的文件夹开始，递归地搜索所有的子目录及源文件RECURSIVE = YES#在最后生成的文档中，把所有的源代码包含在其中SOURCE BROWSER = YES$这会在HTML文档中，添加一个侧边栏，并以树状结构显示包、类、接口等的关系GENERATE TREEVIEW ＝ALL3. 程序源码文档化准备好Doxygen 的工作环境后，就需要根据Doxygen 所定义的注释规则，对程序源码进行文档化。

使用文档生成器Doxygen为c#项目生成文档

使⽤⽂档⽣成器Doxygen为c#项⽬⽣成⽂档⽂档⽣成器——Doxygen⼀、简介Doxygen是⼀种开源跨平台的，以类似JavaDoc（java开发环境⾃带的API⽂档⽣成⼯具）风格描述的⽂档系统，完全⽀持C、C++、Java、Objective-C和IDL语⾔，部分⽀持PHP、C#。

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

Doxgen可以从⼀套归档源⽂件（根据⽂件的形成规律和特点,保持⽂件之间的有机联系,区分不同价值,便于保管和利⽤的⽂件整理。

）开始，⽣成HTML格式的在线类浏览器，或离线的LATEX、RTF参考⼿册。

⼆、功能及特点Doxygen 是⼀个程序的⽂件产⽣⼯具，可将程序中的特定批注转换成为说明⽂件。

减轻程序维护负担，添加⽂件整理负担。

三、安装相关程序本⽂使⽤的为Doxygen 1.8.143.1、Doxygen我们将在配置的时候使⽤doxywizard，Doxygen的GUI版本。

3.2、HTML Help Workshop下载其中的htmlhelp.exe并安装，记住安装⽬录，我们将在Doxygen配置时使⽤。

3.3、 Graphvizgraphviz 是⼀个由AT&T实验室启动的开源⼯具包，⽤于绘制DOT语⾔脚本描述的图形。

Doxygen 使⽤ graphviz ⾃动⽣成类之间和⽂件之间的调⽤关系图，如不需要此功能可不安装该⼯具包。

安装并记录安装⽬录，同样我们⼀会在配置Doxygen时使⽤。

添加系统环境变量：.建⽴变量名GRAPHVIZ_DOT值为安装的路径C:\Program Files (x86)\Graphviz2.34\bin\dot.exe，在⽤户环境变量添加以下⼀个变量，建⽴变量名 GRAPHVIZ_INSTALL_DIR, 值为如C:\Program Files (x86)\Graphviz2.34，在系统环境变量中建⽴变量名PATH中添加Graphviz的bin⽬录路径，如C:\Program Files (x86)\Graphviz2.34\bin四、使⽤（请勿包含中⽂路径）Doxygen 产⽣⽂档可以分为三个步骤。

autogen 使用示例

autogen 使用示例Autogen是一个用于生成文档、代码和其他自动生成内容的工具。

它通常与Doxygen一起使用，Doxygen是一个用于生成软件文档的工具。

下面我将为你提供一个简单的示例来展示如何使用Autogen。

首先，假设你有一个C++项目，其中包含一些源文件和头文件。

你想要生成这些文件的文档，并且希望自动生成一些代码注释。

你可以按照以下步骤来使用Autogen：1. 首先，确保你已经安装了Autogen和Doxygen。

你可以在它们的官方网站上找到安装指南和文档。

2. 在你的项目根目录下创建一个配置文件，比如`autogen.cfg`，用来配置Autogen的行为。

在这个配置文件中，你可以指定要生成文档的文件、生成的文档格式以及其他参数。

这个配置文件的具体内容会根据你的项目需求而有所不同。

3. 编写Doxygen风格的注释。

在你的源文件和头文件中，使用Doxygen风格的注释来描述你的代码。

这些注释将被Autogen用来生成文档。

4. 运行Autogen。

在命令行中进入你的项目目录，然后运行Autogen命令，指定你的配置文件作为参数。

Autogen将会读取配置文件并根据其中的设置来生成文档和其他内容。

5. 检查生成的文档和代码。

Autogen将会生成一些文件，比如HTML格式的文档和一些自动生成的代码文件。

你可以查看这些文件，确保它们符合你的期望。

通过上述步骤，你可以使用Autogen来生成文档和其他自动生成内容。

当然，实际使用中可能会涉及更多的细节和配置，具体的操作取决于你的项目需求和Autogen的功能特性。

希望这个示例能帮助你了解如何使用Autogen。

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

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

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

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

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

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

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

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

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工具使用手册（中文帮助）

强⼤的Doxygen⼯具使⽤⼿册（中⽂帮助）张三：假如我们⾃⼰开发了⼀个类库，怎么做⼀个⽅便阅读的⽂档呢？李四：⼀个⽅法⼀个⽅法地写呗，就像写Excel⽂档⼀下。

张三：啊，你out了，这多慢呀。

为什么不玩玩doxygen⼯具，它能帮你⽣成⽂档？李四：这么爽，什么东东，给说讲讲。

1. Doxygen, what？Doxgen就是⼤名⿍⿍的⽂档⽣成⼯具，⽽且是免费开源的，它使⽤⾮常⽅便，能提取C++，Java，Objective-C，Python，IDL，PHP，C#等语⾔的注释，从⽽⽣成⽂档。

你可以访问其官⽅⽹站，下载安装包，它的官⽹上有详细的使⽤⼿册。

⽀持的主要语⾔格式Extension Language.idl IDL.ddl IDL.odl IDL.java Java.cs C#.c C.cpp C++可产⽣出来的⽂档格式有：HTMLXMLLaTeXRTFCHM要让⼯具能提取注释，那么就要求你写的注释要按照⼀定的规则来写，不能乱写，不然该⼯具是⽆法识别的，通常在Java中，只要JavaDoc能识别的，doxgen也能识别。

2. 安装Doxygen我们可以在这个⽹址去下载最新的安装包安装过程就不⽤说了，很简单，直接Next，最后Finish就OK了。

3. 配置Doxygen配置doxgen是最核⼼的，你可以设置你要提取注释的源⽂件，⽣成的⽂档格式，⼯程名称，⽂档的Logo等信息，这些配置是可以存储起来的，当你的源代码更新后，重新再运⾏这个配置⽂件，就可以重新⽣成⼀个新的⽂档。

在安装后，进⼊到其安装⽬录下的bin⽂件夹，它⾥⾯有两个⽂件：doxygen.exe和doxywizard.exe，我们先运⾏doxywizard.exe来进⾏配置，从⽽⽣成配置⽂件（如果是第⼀次运⾏）。

图1，Doxygen配置主界⾯。

1，Doxygen⼯作⽬录，就是⽤来存储配置⽂件的⽬录。

2，递归搜索⽬录需要选上。

图2，选择输出⽂档格式图3，⽣成类图图4，选择⽂档的编码格式。

doxygen生成源码文档

doxygen⽣成源码⽂档使⽤doxygen ⽣成源代码的⽂档是相当⽅便的，本⽂就简单整理下doxygen的使⽤说明1. 安装　关于安装的问题不做特殊的说明，这⾥直接使⽤命令安装，源码安装不做介绍ubuntu:　sudo apt-get install doxygencentossudo yum install doxygen2. 配置⽂件配置　关于doxygen主要的部分就在于配置⽂件的配置， doxygen相当强⼤，所以配置⽂件内容有点多。

这⾥只介绍⼀部分，⼤家有兴趣可以继续深⼊研究　(1) 重要标记配置⽂件采⽤ <TAGNAME> = <VALUE> 这样的结构，与 Make ⽂件格式相似。

下⾯是最重要的标记： <OUTPUT_DIRECTORY>：必须在这⾥提供⼀个⽬录名，例如 /home/user1/documentation，这个⽬录是放置⽣成的⽂档⽂件的位置。

如果提供⼀个不存在的⽬录名，doxygen 会以这个名称创建具有适当⽤户权限的⽬录。

<INPUT>：这个标记创建⼀个以空格分隔的所有⽬录的列表，这个列表包含需要⽣成⽂档的 C/C++ 源代码⽂件和头⽂件。

例如，请考虑以下代码⽚段： INPUT = /home/user1/project/kernel /home/user1/project/memory 在这⾥，doxygen 会从这两个⽬录读取 C/C++ 源代码。

如果项⽬只有⼀个源代码根⽬录，其中有多个⼦⽬录，那么只需指定根⽬录并把<RECURSIVE> 标记设置为 Yes。

<FILE_PATTERNS>：在默认情况下，doxygen 会搜索具有典型 C/C++ 扩展名的⽂件，⽐如.c、.cc、.cpp、.h和.hpp。

如果<FILE_PATTERNS> 标记没有相关联的值，doxygen 就会这样做。

自动生成帮助文档工具——Doxygen的使用示例（C++）

⾃动⽣成帮助⽂档⼯具——Doxygen的使⽤⽰例（C++）在项⽬中⽤了Doxygen来制作⽂档，记录备忘。

查了不少⽂章，主要使⽤⽅法及例⼦参考都是来⾃以下链接：使⽤步骤：⼀、安装内容1 安装 Doxygen(Windows)2 安装 graphviz(Windows)　因为项⽬⽐较⼩所以没有安装graphviz3 安装 Windows Help Workshop　要⽣成 CHM 格式的⽂档需安装⼆、配置Doxygen1 写的代码注释很多都是中⽂的，如果源码是GB2312格式，记得转为UTF-8格式。

直接输⼊GB2312格式没有尝试。

2 Export Label 下的HTML选项中，CHM_INDEX_ENCODING选项要使⽤GB2312，否则⽣成的CHM中会显⽰乱码。

（实际上在使⽤CHM 中的搜索功能时仍存在乱码，未解决）3 记住要添加 hhc.exe 的路径。

三、代码⽰例此⽰例在链接⽰例基础上修改，简单的注释变量、函数、类等基本够⽤了。

注释应该还有⼀些其他的功能，有时间需要深⼊了解⼀下。

PS:例如想插⼊⼀些调⽤函数的⽰例代码。

.h/*** @file** 此⽂件⽤于定义class example**@auther ...*////定义EXAMPLE_OK的宏为0#define EXAMPLE_OK 0/*** @brief 类的简短说明** 此类⽤于doxygen的使⽤说明**/class Example {private:///变量var1int var1;public:///变量var2int var2;///变量var3int var3;void ExFunc1(void);void int ExFunc2(int a,char b);char *ExFunc3(char *c);}View Code.cpp/*** @file** 此⽂件⽤于定义example class 的 * member function** @author ...*//*** @brief ExFunc1 的简易说明** ExFunc1没有任何参数及返回值*/void Example::ExFunc1(void){//code}/*** @brief ExFunc2 的简易说明** ExFunc2()传回两个参数相加的值 ** @param a ⽤来相加的参数* @param b ⽤来相加的参数* @return 传回两个参数相加的结果 */int Example::ExFunc2(int a,int b){return(a+b);}/*** @brief ExFunc3的简易说明** ExFunc3()只传回参数输⼊的指标。

一款常用文档生成工具：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 是一种开源跨平台的，以类似JavaDoc 风格描述的文档系统，完全支持C 、C++、Java 、Objective-C 和IDL 语言，部分支持PHP 、C#。

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

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

本文通过“step by step ”方式对Doxygen 进行快速入门介绍修订历史版本日期原因V1.00 2012/07/04 创建文档销售与服务网络（一）广州周立功单片机科技有限公司地址：广州市天河北路689号光大银行大厦12楼F4 邮编：510630电话：(020)38730916 38730917 38730972 38730976 38730977 传真：(020)38730925 网址：新浪微博：ZLG-周立功（/ligongzhou ）广州专卖店地址：广州市天河区新赛格电子城203-204室电话：(020)87578634 87569917 传真：(020)87578842南京周立功地址：南京市珠江路280号珠江大厦1501室电话：(025) 68123901 68123902 传真：(025) 68123900北京周立功地址：北京市海淀区知春路113号银网中心A 座1207-1208室（中发电子市场斜对面）电话：(010)62536178 62536179 82628073 传真：(010)82614433重庆周立功地址：重庆市石桥铺科园一路二号大西洋国际大厦（赛格电子市场）1611室电话：(023)68796438 68796439 传真：(023)68796439杭州周立功地址：杭州市天目山路217号江南电子大厦502室电话：(0571)89719480 89719481 89719482 89719483 89719484 89719485 传真：(0571)89719494成都周立功地址：成都市一环路南二段1号数码科技大厦403室电话：(028)85439836 85437446 传真：(028)85437896深圳周立功地址：深圳市福田区深南中路2072号电子大厦12楼电话：(0755)83781788（5线）传真：(0755)83793285武汉周立功地址：武汉市洪山区广埠屯珞瑜路158号12128室（华中电脑数码市场）电话：(027)87168497 87168297 87168397 传真：(027)87163755上海周立功地址：上海市北京东路668号科技京城东楼12E 室电话：(021)53083452 53083453 53083496 传真：(021)53083491西安办事处地址：西安市长安北路54号太平洋大厦1201室电话：(029)87881296 83063000 87881295 传真：(029)87880865厦门办事处E-mail ：sales.xiamen@沈阳办事处E-mail ：sales.shenyang@销售与服务网络（二）广州致远电子股份有限公司地址：广州市天河区车陂路黄洲工业区3栋2楼邮编：510660传真：(020)38601859网址：新浪微博：ZLG-周立功（/ligongzhou）技术支持：CAN-bus：电话：(020)22644381 22644382 22644253 邮箱：can.support@ iCAN及数据采集：电话：(020)28872344 22644373 邮箱：ican@MiniARM：电话：(020)28872684 28267813 邮箱：miniarm.support@ 以太网：电话：(020)22644380 22644385 邮箱：ethernet.support@无线通讯：电话：(020) 22644386 邮箱：wireless@ 串行通讯：电话：(020)28267800 22644385 邮箱：serial@编程器：电话：(020)22644371邮箱：programmer@ 分析仪器：电话：(020)22644375 邮箱：tools@ARM嵌入式系统：电话：(020) 22644383 22644384 邮箱：NXPARM@ 楼宇自动化：电话：(020)22644376 22644389 28267806 邮箱：mjs.support@mifare.support@销售：电话：(020)22644249 22644399 22644372 22644261 28872524 28872342 28872349 28872569 28872573 38601786维修：电话：(020)22644245目录1. 简介 (1)2. 安装 (2)3. 运行第一个示例 (3)3.1 打开图形向导Doxywizard (3)3.2 选择配置文件 (3)3.3 生成文档 (3)3.4 浏览文档 (4)4. 单模块简单示例 (5)4.1 编写注释 (5)4.1.1 有效注释 (6)4.1.2 定义模块 (6)4.1.3 加入到模块 (6)4.1.4 函数注释 (6)4.2 生成配置 (6)4.2.1 项目配置 (6)4.2.2 模式配置 (7)4.2.3 输出配置 (7)4.2.4 图表配置 (8)4.2.5 支持中文 (8)4.2.6 保存配置文件 (9)4.3 生成文档并浏览 (9)5. 多模块示例 (10)5.1 几个常用标记 (10)5.1.1 @addtogroup (10)5.1.2 @{和@} (10)5.1.3 成员注释 (10)5.2 多模块文档化 (11)5.2.1 DI模块文档化 (11)5.2.2 DO模块文档化 (13)5.2.3 生成文档 (15)6. 注释的书写建议 (16)6.1 注释原则 (16)6.2 对比示例 (16)7. 生成离线文档 (18)7.1 CHM格式 (18)7.1.1 生成CHM索引 (18)7.1.2 建立CHM工程 (18)7.1.3 编译CHM工程 (18)7.1.4 查看CHM文件 (18)7.2 RTF和word格式 (19)7.3 PDF格式 (19)8. FAQ (20)9. 免责声明 (21)1. 简介Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。

vscode 中doxygen documentation generator 的使用方法

vscode 中doxygen documentationgenerator 的使用方法The topic I will be discussing is the usage of the Doxygen documentation generator in vscode.在这篇文章中，我将介绍如何在vscode中使用Doxygen文档生成器。

Doxygen is a powerful tool that automatically generates documentation from specially formatted comments in source code. It supports a wide range of programming languages, including C++, Python, and Java. Having good documentation not only benefits developers by providing clearexplanations of code functionality, but it also helps to ensure better collaboration within teams and makes iteasier for newcomers to understand and contribute to projects.Doxygen是一个强大的工具，它可以从源代码中特定格式的注释自动生成文档。

它支持多种编程语言，包括C++、Python和Java等。

良好的文档不仅有益于开发人员，提供清晰的代码功能解释，而且有助于确保团队内更好的协作，并使新手更容易理解和贡献项目。

To start using Doxygen with vscode, you need to have Doxygen installed on your system. You can easily download Doxygen from their official website and follow the installation instructions. Once installed, ensure that the Doxygen executable is added to your system's PATH environment variable so that it can be accessed from any directory.要在vscode中使用Doxygen，您需要在系统中安装Doxygen。

doxygen markdown 语法

doxygen markdown 语法Doxygen是一款用于生成代码文档的工具，它支持多种编程语言，并且可以将代码注释自动转换为文档形式。

本文将详细介绍Doxygen 的Markdown语法，以帮助开发者更好地使用这一工具。

## 1. 概述Doxygen是一款强大的代码文档生成工具，它可以帮助开发者自动生成符合特定格式的代码文档。

Markdown语法是Doxygen所支持的一种注释格式，它可以将源代码中的注释自动转换为有序的文档结构。

下面将详细介绍Doxygen Markdown的使用方法。

## 2. 注释语法Doxygen Markdown的注释语法与常见的Markdown语法略有不同。

以下是几个常用的注释标记示例：### 2.1. @brief使用`@brief`标记可以简洁地描述函数或类的基本功能。

例如：```/*** @brief 计算两个整数的和* @param a 第一个整数* @param b 第二个整数* @return 两个整数的和*/int sum(int a, int b) {return a + b;}```### 2.2. @param使用`@param`标记可以描述函数的参数。

例如：```* @brief 计算两个整数的差* @param a 第一个整数* @param b 第二个整数* @return 两个整数的差*/int subtract(int a, int b) {return a - b;}```### 2.3. @return使用`@return`标记可以描述函数的返回值。

例如：```/*** @brief 计算两个整数的乘积* @param a 第一个整数* @param b 第二个整数* @return 两个整数的乘积*/int multiply(int a, int b) {return a * b;}```### 2.4. @code使用`@code`标记可以在文档中插入代码块。

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 源代码文档自动生成器的使用笔记class Shape{public:Shape();~Shape();virtual void Draw(CDC* pDC);};// shape.cpp/** \file* <pre>Richard Zeng Shape Class File Source</pre> * <pre>Copyright and Use</pre>* \author Richard Zeng* \date 2006-3-23* <pre></pre>All rights reserved.*/~上面的就不用说了吧#include"shape.h"~解释，随便你写什么都可以的~这里我们可以看出在CPP中加注释比较好~每个函数的实现都必须加上注释否则就没有这个函数拉/** default constructor*/Shape::Shape(){}/** destructor */Shape::~Shape(){}/** Draw funtion for this shape* \param CDC* pointer to MFC CDC*/~ \param 为Doxygen的关键字用于定义参数~ \return 为返回关键字void Shape::Draw(CDC* pDC){}//Rectangle.h/** \file __FILE__* <pre>Richard Zeng Shape Class File Source</pre> * <pre>Copyright and Use</pre>* \author Richard Zeng* \date 2006-3-23* <pre></pre>All rights reserved.*/#include"shape.h"/** Rectangle class define*/class Rectangle:public Shape{public:Rectangle();~Rectangle();void Draw(CDC*pDC);private:int width,height;};//Rectangle.cpp/** \file __FILE__* <pre>Richard Zeng Shape Class File Source</pre> * <pre>Copyright and Use</pre>。