doxygen

$ doxygen -g <config-file> $ doxygen <config-file> 在html目录下可以看到生成的文档 来源： oschina 链接： https://my.oschina.net/u/4290180/blog/3229434

Doxygen是一种开源跨平台的，类似JavaDoc风格描述的文档系统，支持C、C++、Java、Objective-C等语言。可以从一套归档源文件开始，生成HTML，XML，pdf等不同风格的格式。 按照约定的格式注释源代码，用工具处理注释过的源代码产生文档，通过这种方式产生文档，有以下几个好处。 1. 便于代码和文档保持同步 2. 可以对文档做版本管理 使用方法 要使用Doxygen生成文档，主要有两件事 1. 一般用Doxywizard生成Doxyfile后，再手工修改或者通过向导进行修改。建议，一个项目使用单独的Doxyfile配置文件。 2. 按照Doxygen的约定，将代码文档化 3. 执行 doxygen Doxyfile Doxygen统一采用UTF-8作为输出文件的编码格式。但微软的CHM编译工具(hhc.exe)不支持UTF-8，它支持GB2132 Doxygen的最新版本，可以从 Doxygen的网站 下载，我使用的是doxygen-1.8.7-setup.exe Graphviz是一个图形可视化软件。Doxygen使用Graphviz生成各种图形，例如类的继承关系图、合作图，头文件包含关系图等。可以从 Graphviz的网站 下载Graphviz的最新版本。Doxygen使用了Graphviz的布局引擎dot，所以在文档中将其称作dot。 Mode页面

1 前言 linux下安装MySQL的方式有很多种，包括以仓库的方式安装(yum,apt,zypper)，以包的方式安装(rpm,deb)，以docker方式安装，从压缩包解压安装，从源码编译安装，这里使用的是最后一种，从源码编译安装。 编译安装需要大量的耐心与时间，而且还会遇到非常多奇奇怪怪的问题，因此，需要极大的毅力，很有可能一万次失败也换不来一次的成功，请做好心理准备。 2 准备工作 下面是安装要求，已安装的可以跳过。 cmake boost gcc ncurses openssl bison doxygen 2.1 gcc gcc的话一般linux都配备，最低要求版本为5.3，需要更新的话可以看笔者的 另一篇博客 。 2.2 boost boost不需要手动安装，后面运行cmake脚本的时候会自动下载安装，当然也可以手动安装，官网的文档说是需要特定版本，这里的MySQL Server 8.0.19需要的是1.70.0，目前最新的boost库为1.72.0。 2.3 cmake 看笔者的 另一篇博客 。 2.4 其他 其他一般使用仓库安装即可，当然也可以每一个都去折腾从源码安装，你喜欢就好。 2.4.1 Red Hat系 7.x： sudo yum install -y bison bzip2 git hostname ncurses-devel openssl

图形和图表 Doxygen具有内置支持，可以为C ++类生成继承图。 Doxygen可以使用graphviz中的“点”工具来生成更高级的图表。Graphviz是一个开放源代码，跨平台的图形绘制工具包，可以在http://www.graphviz.org/上找到 。 如果路径中有“点”工具，则可以在配置文件中将 HAVE_DOT 设置为 YES ，以便doxygen使用它。 Doxygen使用“点”工具生成以下图形： 将绘制类层次结构的图形表示形式以及文本形式的图形表示形式。当前，仅HTML支持此功能。 **警告：**当您有一个非常大的类层次结构，其中许多类是从一个公共基类派生的时，生成的图像可能变得太大而无法用于某些浏览器。 将为每个记录的类生成一个继承图，显示直接和间接继承关系。这将禁用内置类继承图的生成。 为每个包含至少一个其他文件的文档文件生成一个包含依赖关系图。当前仅HTML和RTF支持此功能。 还会生成一个反向包含相关性图，显示一个（头）文件，其他文件也包含该文件。 为每个记录的类和结构绘制一个图形，该图形显示： 与基类的继承关系。 与其它结构和类（例如类的使用关系 A 具有一个成员变量 m_a 类型的类 B ，然后 A 有一个箭头来 B 以 m_a 作为标签）。 如果 CALL_GRAPH 设置为YES，则会为每个函数绘制一个图形调用图，以显示该函数直接或间接调用的函数

JAVA语言中的代码注释那是相当好的一个东西，尤其是使用了Eclipse之后，简直是程序员的福音。小弟前几天用了一下午的时间，经过在网上的查找以及我一点点的探索，终于搞定在windows平台下，使用 Eclipse for c/cpp + doxygen + graphviz 自动提示代码注释以及生成HTML格式的文档。 还不知道doxygen的同学，请自行百度/Google 声明：JDK以及mingw的安装和配置请自行解决，这里的测试以C语言为主 使用到的软件： jdk mingw eclipse for c/cpp doxygen eclox graphviz 一、安装doxygen、graphviz以及eclipse插件：eclox doxygen、graphviz的安装比较简单，就是典型的下一步，不再赘述。 然后就是在eclipse【实际上是 Eclipse IDE for C/CPP ，以下简称为 eclipse】中安装doxygen的插件 eclox了，它的下载地址 http://home.gna.org/eclox/ 至于 eclipse 安装插件的方法，这里推荐使用 link 安装方法，具体的作法不再多说 安装好之后，还要做一些设置： 1、window->preferences->doxygen 在右侧点击 Add,添加doxygen安装目录的bin目录

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、 Objective-C 和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档 源文件 开始，生成HTML格式的在线类 浏览器 ，或离线的LATEX、RTF参考手册。 Doxygen 是一 个程 序的文件 产 生工具， 可将 程序中的特定批注 转换 成 为说 明文件 。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言， 要直接探索程序里的批注，与打 捞铁达尼号 同 样 的辛苦 。大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构， 将批注经过处 理重新整理成 为 一 个纯 粹的 参考手册 ， 对 于后面利用您的程序 代码 的人而言 将会减少许 多的 负担 。不过，反过来说， 整理文件 的工作对于您来说，就是沉重的负担。 Doxygen 就是在您写批注时，稍微按照一些它所制订的规则。接着，他就可以帮您产生出漂亮的文档了。 因此，Doxygen 的使用可分为两大部分。首先是 特定格式的批注撰 写 ，第二便是 利用 Doxygen 的工具 来产 生文档 。 使用步骤 1 、第一次使用需要安装 doxygen 的程序 2 、生成 doxygen 配置文件 3 、编码时

程序文档，曾经是程序员的一个头痛问题。写一个程序文档，比较花时间，但不是很难；麻烦的是当程序修改后，程序文档也要跟着同步更新，否则文档和程序就要脱节，文档也就变成没用的东西了。 好在有许多好用的文档生成器来解决这个问题。目前比较流行的C++文档生成器是doxygen。 本文就简单的介绍一下doxygen的文档注释方法，以供初学者参考： C++ 程序文档生成器介绍(doxygen) 沐枫网志 1. 模块定义（单独显示一页） /* * @defgroup 模块名 模块的说明文字 * @{ */ ... 定义的内容 ... /** @} */ // 模块结尾 2. 分组定义（在一页内分组显示） /* * @name 分组说明文字 * @{ */ ... 定义的内容 ... /** @} */ 3. 变量、宏定义、类型定义简要说明 /** 简要说明文字 */ #define FLOAT float /** @brief 简要说明文字（在前面加 @brief 是标准格式） */ #define MIN_UINT 0 /* * 分行的简要说明 \n * 这是第二行的简要说明 */ int b; 4. 函数说明 /* * 简要的函数说明文字 * @param [in] param1 参数1说明 * @param [out] param2 参数2说明 * @return 返回值说明 */ int