Doxygen的介绍和使用

最新推荐文章于 2022-02-16 10:41:08 发布
最新推荐文章于 2022-02-16 10:41:08 发布
阅读量1.4k 收藏 1
点赞数
分类专栏： 开发工具 文章标签： 文档 postscript fortran javadoc html rtf
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sikinzen/article/details/5586894
版权

版本记录

日期

修订版本

描述

作者

2009-05-11

0.0.1

初稿

温陵布衣

    
    


目录

版本记录... 2

目录... 3

1 概述... 4

1.1 简介... 4

1.2 能完成的工作... 4

1.3 功能框图... 4

2 如何使用... 5

2.1 首次使用... 5

2.1.1 中文乱码的解决方法... 6

2.2 命令行方式... 6

2.2.1 新建配置文件... 6

2.2.2 运行doxygen. 6

2.2.3 文档化代码... 6

3 入门文章... 6

4 配置文件... 6

5 如何文档化源码... 7

6 进阶... 7

7 参考文献... 7

8 联系方式... 7


1 概述

1.1 简介

本节以Doxygen-1.6.2为例，介绍该工具的概貌。

Ø 功能：将源码中的注释提取出来，形成各种输出格式的文档；

Ø 支持的编程语言：完全支持 C、C++、Java、IDL、Objective-C、Python、PHP、C#、Fortran、VHDL，部分支持D；

Ø 输出格式：直接支持 HTML、Latex、RTF、manpage、Qt help project、XML，间接支持 chm、Qt Compressed Help、Postcript和PDF；

Ø 兼容 JavaDoc、Qt-Doc、KDOC等类似工具；

Ø 支持平台：Unix（包括Linux）、MacOs、Windows等；

Ø 主页：http://www.doxygen.org/

邮件列表：

doxygen-user@lists.sourceforge.net

doxygen-develop@lists.sourceforge.net

Ø 作者：Dimitri van Heesch (dimitri@stack.nl) ；

Ø 参考手册：Doxygen 安装目录下的参考手册；

1.2 能完成的工作

Ø 它能从一系列源文件中生成在线浏览文档（HTML形式）或离线参考手册（LATEX形式）。还支持RTF（MS-Word），PostScript，带超链接的PDF，压缩的HTML和Unix man页。文档是直接从源文件中提取出来的，这使得文档与源代码很容易保持同步；

Ø 通过配置doxygen，你可以从未文档化的源文件中提取出代码结构。这对于从大的源码包中快速理清头绪是非常有用的。它还能自动产生出包含关系图、继承图和协作图，使你能直观地看出各种元素间的关系；

Ø 你甚至可以“滥用“doxygen来创建平常的文档，Doxygen的手册(manual)即是这么产生的。

1.3 功能框图

功能框图，描述了Doxygen的信息流，见下图。

clip_image004

2 如何使用

2.1 首次使用

Doxygen具有 图形化 和 命令行 两种操作模式。对于初学者，前者非常容易上手。

Ø 打开 bin/ doxywizard.exe，在向导中设置各项参数。主要是设置 Wizard->Project页面下的内容，其他页面可以保持默认值。这一标签页主要是设置欲读取源码的地址以及输出文档的地址。特别注意的是：必须勾上 “Scan recursively”选项；

Ø 在 doxywizard.exe 里，打开 Run 标签页，选择工作目录后，点击 Run doxygen 按钮，则自动在上面设置的目标目录下产生各种输出：html、Latex等；

2.1.1 中文乱码的解决方法

这边有个要特别注意的地方------字符集的问题：假如你欲读取的文档中的中文注释中采用的是GB2312（如 Source insight、记事本等编辑工具，默认的中文字符集即为GB2312），那么生成的文档中中文将是乱码。这是因为 Doxygen 默认 输入字符集 为UTF-8。我们只需将 Expert->Input->INPUT_ENCODING 修改为GB2312 即可解决该问题。

2.2 命令行方式

本节介绍 命令行操作的三个步骤。

2.2.1 新建配置文件

有两种方法。

第一种：通过如下命令产生默认配置文件，而后根据需要编辑 配置文件。

        doxygen -g

第二种：通过上节说到的 doxywizard.exe 工具配置，而后保存配置文件。

配置文件的说明，参考 Doxygen 手册的 Configuration 一节。

2.2.2 运行doxygen

运行如下命令以生成文档。

doxygen -g

2.2.3 文档化代码

本节和上一节介绍了 doxygen 的GUI 和 Command 两种操作方式。大家根据上面的介绍生成的文档往往觉得没有人家 Doxygen 的手册好看。这就是缺少 文档化 的缘故。什么叫“文档化“，其实就是讨论怎么把你的注释恰当地放在代码中，以产生美观的文档。文档化也就是告诉我们：你要用好 Doxygen 的话，应该怎么写源码的注释。

显而易见，虽然这一节放在第三个步骤，但在一个新的项目中，这显然应该是第一个步骤。

3 入门文章

写到这边，突然在网上查到了 参考文献[2-4] 这几篇文章。觉得没必要再写了，人家已经写得相当好了。

就入门而言，先读参考文献[4]，再读参考文献[3]。

4 配置文件

参考 doxygen manual 和 参考文献[2]。

5 如何文档化源码

参考 doxygen manual 和 参考文献[2]。

6 进阶

参考 doxygen manual 和 参考文献[5]。

参考文献[5] 提供了一种在Vim中自动输入Doxygen 注释的方式。

7 参考文献

1. doxygen_manual-1.6.2.chm：位于Doxygen的根目录

2. 学习用 doxygen 生成源码文档 主要学习该文对配置参数的讨论

3. Doxygen介绍 里面的几个注释示例比较好

4. 快速上手 快速上手 Doxygen

5. doxygen+VIM文档实用指南 vim 中增加一些写 doxygen注释 的宏

8 联系方式

希望这份文档对您有所帮助，若您发现任何问题或有任何更好的建议，欢迎与我联系！

温陵布衣：

MSN: sikinzen@hotmail.com

Mail: sikinzen @yahoo.com.cn

QQ: 526679213

sikinzen
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
symbian 用doxygen生成交叉引用文档
04-27 681
 昨天我用perlwebserver弄了一个简单的server。今天就派上用场了，用doxygen生成的html文档，放到server目录下，大家都可以通过网页的方式看你的代码了并且很方便！ 在这里https://olex.openlogic.com/packages/doxygen下载1.5.6安装到windows上，然后在carbide c++里面，find and install n
doxygen的基本标注规则及实例
weixin_45687825的博客
10-21 1670
文章目录doxygen的基本标注规则及实例注释格式Doxygen常用注释命令Doxygen注释示例项目注释文件注释函数注释枚举、结构体等注释模块注释分组注释 doxygen的基本标注规则及实例 参考文章 注释格式 块注释建议统一使用 /** * comment */ 行注释建议统一使用 ///...comment... /** …… */ Doxygen常用注释命令 /** * @exception <exception-object> {exception description}
Doxygen详细介绍（一）（Doxygen概述及本系列文章目录）
weixin_34301307的博客
08-06 188
1 序言      为代码写注释一直是大多数程序员有些困扰的事情。当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法，但对哪些地方应该写注释，注释如何写，写多少等这些问题，很多程序员仍然没有答案。更头痛的是写文档，以及维护文档的问题，开发人员通常可以忍受编写或者改动代码时编写或者修改对应的注释，但之后需要修正相应的文档却比较困难。如果能从注释直接转化成文档，对开发人员无疑是一种福...
Doxygen详细介绍
热门推荐
Timmy_zhou的专栏
02-24 1万+
1   序言     为代码写注释一直是大多数程序员有些困扰的事情。当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法，但对哪些地方应该写注释，注释如何写，写多少等这些问题，很多程序员仍然没有答案。更头痛的是写文档，以及维护文档的问题，开发人员通常可以忍受编写或者改动代码时编写或者修改对应的注释，但之后需要修正相应的文档却比较困难。如果能从注释直接转化成文档，对开发人员无疑是
Doxygen语法
老孙
03-24 6558
Doxygen语法 1. 模块定义（单独显示一页） /*  * @defgroup 模块名 模块的说明文字  * @{  */    ... 定义的内容 ...   /** @} */ // 模块结尾   2. 分组定义（在一页内分组显示） /*  * @name 分组说明文字  * @{  */    ... 定义的内容 ...   /** @} */
Doxygen VA快捷键使用说明
08-11
本文将详细介绍如何在VA中使用Doxygen快捷键来提高工作效率。 1. **安装与配置** 在使用Doxygen VA快捷键之前，你需要确保已经安装了Doxygen和VA。VA插件可以在其官方网站下载，安装后在Visual Studio中进行配置，...
使用 doxygen 生成 chm 文档
03-07
详细介绍doxygen各种注释标准、方法，并生成chm的过程
doxygen使用指南
09-09
该指南简要介绍了doxygen的使用，包括注释部分及可能出现的代码。附有图及相关说明。
doxygen安装及使用
11-29
在本文中，我们将详细介绍Doxygen的安装过程以及如何使用它来构建文档。 ### 一、Doxygen的安装 1. **下载Doxygen**: 首先，你需要访问Doxygen的官方网站（http://www.doxygen.nl/）下载最新版本的源码包或二进制...
doxygen 注释规范_Doxygen简明注释语法
weixin_35884307的博客
02-23 6723
语法简介Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。提供了一套注释方式便于把代码中的注释生成说明文档。很多开源项目都在使用，例如：下面是常用的注释简介。1. 简单注释单行注释：///或者//!多行注释：/**或者/*!2. 文件注释文件注释通常放在整个文件开头。/*** @file 文件名* @brief 简介* @details 细节* @mainpage 工...
doxygen使用与C++注释规范
zhikui3838的博客
09-03 1109
1.   doxygen的安装与参数配置 1.1.  安装 $ sudo apt-get install doxygen 以下可以选择安装 $sudo apt-get install doxygen-doc doxygen-gui graphviztexpower dot2tex graphviz-doc texpower-examples 1.2.  生成
doxygen简单介绍
奇异天空的博客
01-20 4090
doxygen简单介绍 概述 doxygen官方文档 这是一个生成文档的工具,可以通过代码文件中的注释进行文档的生成,通过画图工具可以绘制调用过程和文件包含关系等 安装 sudo apt-get install doxygen doxygen-gui doxygen-gui是一个可以通过图形界面生成配置文件的工具 使用 只要在代码注释中做了特殊的标记,就使用这个工具
Doxygen 代码文档系统
生活需要深度
02-16 754
Doxygen是一个开源跨平台的蕾西JavaDoc风格描述的文档系统，其可以通过一套归档源文件生成HTML/LATEX/RTF格式参考手册。
Doxygen使用总结
梦想腾飞
09-05 1975
doxygen [功能] 为许多种语言编写的程序生成文档的工具。 [举例] *生成一个模板配置文件，模板文件中有详细的注释： $doxgen -g test 这样，会生成一个test文件,1500多行，可以把这个文件做为模板编写配置文件。如果之前有test那么会将原来的test备份为test.bak.模板文件的部分内容如下： ...前面的内容省略.
Doxygen用于Fortran的语法
youshenfan的专栏
12-26 650
Doxygen用于Fortran的语法说明使用要点如何注释常用注释方法提示 说明 本文档由作者翻译自Doxygen官网和整理相关材料而得。 使用要点 使用Doxygen处理fortran代码，应在设置页将OPTIMIZE_FOR_FORTRAN选为YES。 Doxygen解析器将自动判断Fortran语言的格式（固定格式/自由格式）。如解析器有误，则需要人为设置 EXTENSION_MAPPING，如设置为EXTENSION_MAPPING = f=FortranFixed f90=FortranFree，
doxygen中增加自定制的page
davidsu33的专栏
06-16 2696
doxygen对注释支持很多操作，可以自己编写一个全注释的文件，
doxygen使用详解
wangzhengqianw的专栏
12-30 754
来源:http://hi.baidu.com/zkheartboy/blog/item/8ed283cae6a06c80c8176858.htmldoxygen使用详解为代码写注释一直是大多数程序员有些困扰的事情。当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法，但对哪些地方应该写注释， 注释如何写，写多少等这些问题，很多程序员仍然没有答案。更头痛的是写文档，以及维护文档的问题，
Doxygen 配置
axlrosek的专栏
04-09 3160
Step 1: 创建一个配置文件Doxygen使用一个配置文件来确定它所有的设置. 每个工程都应该有它自己的配置文件.一个工程可以只有一个原文件, 也可以是工程中所有原文件的递归扫描得到的原文件的树状视图。为了简化doxygen生成配置文件的工作, doxygen 可以为你提供一个模板化的配置文件. 1. 为了创建一个模板化的配置文件，只需要调用doxygen并从命令行中敲入-g: dox
doxygen 枚举
最新发布
11-23
根据提供的引用内容，无法直接回答doxygen枚举的问题。但是，我们可以简单介绍一下doxygen的作用和用法。 Doxygen是一种自动生成文档的工具，它可以从代码中提取注释并生成HTML，LaTeX（PDF），RTF和其他格式的文档。它支持多种编程语言，包括C ++，C＃，Java，Python等。 在使用Doxygen时，我们需要在代码中添加注释，以便Doxygen可以从中提取信息并生成文档。注释应该包含有关代码的详细信息，例如函数的参数，返回值，用法等。 对于枚举，我们可以使用以下注释格式： ```c++ /** * @brief Brief description of the enum * */ enum MyEnum { VAL1, /**< Description of value 1 */ VAL2, /**< Description of value 2 */ VAL3 /**< Description of value 3 */ }; ``` 在上面的示例中，我们使用了`@brief`标记来提供枚举的简要说明，并使用`/**< ... */`格式的注释来提供每个值的说明。 使用Doxygen生成文档后，我们可以在生成的HTML文档中查看枚举及其值的说明。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值