文档章节

Doxygen初学与简单应用

抢小孩糖吃
 抢小孩糖吃
发布于 2013/02/28 14:42
字数 1132
阅读 14027
收藏 19

本文环境为Windows 7 x64

一直在使用javadoc,奈何c\c++,python等其他语言注释写的很好,但没有工具自动生成文档。

通过同事反应Doxygen可以针对各种语言生成文档内容。随即查阅了Doxygen的相关内容。

Doxygen介绍:

Doxygen 是一个 C++, C, Java, Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D语言的文档生成器。可以运行在大多数类Unix系统,以及Mac OS X操作系统和Microsoft Windows 。 初始版本的Doxygen借鉴了一些老版本DOC++的代码;随后,Doxygen源代码由Dimitri van Heesch重写。

Doxygen是一个编写软件参考文档的工具。 该文档是直接写在代码中,因此比较容易保持更新。 Doxygen 可以交叉引用文档和代码,使文件的读者可以很容易地引用实际的代码。

详细请看http://www.oschina.net/p/doxygen


要想使用Doxygen,需要三大步骤

1.Doxygen及其相关内容下载

1.1Doxygen下载

      由于国内墙了Doxygen的官网,但sourceforge还是可以使用

http://sourceforge.net/projects/doxygen/?source=dlp 进行下载

本文使用的为Doxygen 1.8.3.1

安装,我们将在配置的时候使用doxywizard,Doxygen的GUI版本。

1.2HTML Help Workshop下载

如果你希望你的Doxygen自动生成chm,那么请下载HTML Help Workshop,我们将要使用当中的hcc.exe文件以及相关dll

http://www.microsoft.com/en-us/download/details.aspx?id=21138 进行下载

下载其中的htmlhelp.exe并安装,记住安装目录,我们将在Doxygen配置时使用。

1.3 Graphviz

Graphviz在Doxygen用于自动生成类图的工具。

登陆官网发现被墙了,只能在天朝大局域网内随便找个方便的连接了。

http://download.tech.qq.com/soft/53/54/85568/index.shtml,我们大腾讯肯定不会封

点击下载,请自动忽略旋风下载 =。=

安装并记录安装目录,同样我们一会需要配置Doxygen

2.配置Doxygen

2.1基本配置

在基本配置中,会介绍一些关于Doxygen的基本配置,例如各种乱码,输出内容等。

首先我们打开开始-》所有程序-》Doxygen-》doxywizard

在开始之前,打开Doxygen GUI frontend的File,保存到你需要做测试的目录

会出现一个Doxyfile的配置文件,修改选项后保存,下次通过Doxygen打开这个文件可以还原该项目的配置

第一步,选择你的工作目录(源代码位置),点击Select。

第二步,进行配置

首先修改Project name,选择扫描源代码的目录,Source code directory:,勾选Scan recursively

在Wizard的Topics下的Mode,选择All Entities,可以输出相对完整的功能,是否包含源代码看你自身情况,在下面选择好你的语言。这里作者使用的是C所以选择C or PHP

在Output中,如果你需要输出chm格式,请勾选。

在Diagrams中选择使用GraphViz包,来输出UML。

2.2字符集乱码

Expert中,你需要首选确定你所输出的语言,个人使用中文

在Expert的Input中,很重要的是INPUT_ENCODING项,如果你使用的为微软默认字符集请填写GBK,不然目录乱码。

在Expert的HTML中,首先要看HHC_LOCATION选项,添加安装目录(注:作者目录为D:/build/doxygen/hcc/HTML Help Workshop/hhc.exe)

勾选CHM_INDEX_ENCODING,在你源代码中的字符集是什么就填写什么,作者的C由于使用keil,所以填写为GBK,java对eclipse切换了字符集所以为UTF-8,还有注意给chm命名以方便寻找。

2.3GraphViz的输出

之后在Expert的Dot中勾选CLASS_DIAGRAMS,UML_LOOK

为了减少chm体积,在DOT_IMAGE_FORMAT中选择gif或者jpg,均可。

最后在DOT_PATH下面填入dot.exe的路径

配置GraphViz 暂缺

2.4生成文档

之后点击Run-》Run doxygen。

这时你可以看到一个没有任何注释与说明的关系图。(chm请在html文件内寻找)


3.关于注释格式

由于Doxygen支持 javadoc的格式,但还有部分区别,按照如下方式可以作为注释的模板,可以参考Doxygen的具体文档,形成你自己的风格。

/**
* @brief 说明内容
* @param void
* @return void
* @author 123
* @version v1.0.0.0
* @date 2013
* @since Keil uVision4
* @bug 
* @warning 
*/
结尾:

      注意保存Doxygen的配置文件,下次使用打开该配置即可,Doxygen虽然说明了如何使用,但是作者开始并没进行保存,很多调整的配置项丢失。

© 著作权归作者所有

共有 人打赏支持
抢小孩糖吃

抢小孩糖吃

粉丝 67
博文 236
码字总数 229004
作品 0
东城
程序员
加载中

评论(5)

抢小孩糖吃
抢小孩糖吃

引用来自“我叫mly”的评论

灰常感谢,找到原因了 。在DOT_PATH下面填入dot.exe的路径,也就是graphviz安装目录下的bin文件夹。
你里边说的是dot输出路径,这的问题
已经修改,谢谢
我叫mly
我叫mly
灰常感谢,找到原因了 。在DOT_PATH下面填入dot.exe的路径,也就是graphviz安装目录下的bin文件夹。
你里边说的是dot输出路径,这的问题
我叫mly
我叫mly
你好,我想问一下,我按你这个步骤来的来,但是貌似没找到图片生成去哪了,打开网网页,也没有图片,那个图片输出也没有图片文件,我看到你写着个 配置GraphViz 暂缺 。是不是 GraphViz这个需要配置,如果需要请问有没有相关资料,谢谢13
C
CREPAS
这个不错哦,学习一下,感谢分享
iptvphone
iptvphone
非常有效,感谢分享~.~
FFmpeg编写一个简单播放器 --开篇

FFMPEG是一个很好的库,可以用来创建视频应用或者生成特定的工具。FFMPEG几乎为你把所有的繁重工作都做了,比如解码、编码、复用和解复用。这使得多媒体应用程序变得容易编写。它是一个简单的...

GuoKai
2012/09/19
0
0
Doxygen 1.6.3 发布,文档生成工具

Doxygen, 大名鼎鼎的文档生成工具,被Boost、OpenCasCade等诸多项目作为文档生成的不二人选。人说,才华横溢往往是高深莫测,这句话放在 Doxygen这里显然是不适用的。十八般武艺样样精通的D...

红薯
2010/02/22
705
0
使用Doxgen创建Xcode文档集

http://blog.csdn.net/kmyhy/article/details/6221413 文档集为Xcode开发者提供了一个查找各种文档的便捷方式,包括:API、指南、教程、Q/A、示例代码及其他。 许多开发者都用过苹果文档集,...

JohnZr
2012/08/10
0
0
使用Doxygen构建文档系统

如果您这次还没来得及使用老式的Help Workshop为您的Web应用构建文档系统的话,那么,何不尝试一下Doxygen,需知"The proof of the pudding lies in the eating"。 Doxygen是什么? Doxygen是...

红薯
2009/02/11
2.5K
2
xmake插件使用之doxygen文档生成

这个doxygen插件比较简单,说白了就是一键生成工程文档,只需要执行下面这行命令就行了 当然你也可以指定输出目录,可以工程源码目录: 生成的文档中,工程名和版本号,就是xmake.lua中通过如...

ruki
2016/06/22
7
0

没有更多内容

加载失败,请刷新页面

加载更多

RedHat已更改其开源许可规则

对于编程圈外的人来说,软件许可证似乎并不重要,但是,在开源领域,开源许可是非常重要的。 因此,领先的Linux公司Red Hat宣布了一件大事,所有新的由Red Hat发起的使用GNU通用公共许可证(...

linux-tao
22分钟前
7
0
游戏化策划的反馈机制

简评:如何低成本地设计游戏化活动运营方案 当项目活动组采用游戏化机制来设计活动时,往往会犯一个错误 —— 以为物质奖励(金钱或实物)就是终极奖励。然后一次又一次的证据显示,有形奖励...

极光推送
24分钟前
1
0
PHP "延迟静态绑定" 功能,static

从这个名字的定义提取出两个关键点,第一点静态,也就是说这个功能只适用于静态属性或静态方法。 第二点延迟绑定,这个根据下面代码就可以很好的理解 class A{ static $name = "Tom";...

nsns
28分钟前
1
0
《看图轻松理解数据结构与算法系列》导引贴

最近学习数据结构,遇到一个很喜欢的博主,他的文章图文并茂,理解起来很容易。特此开贴记录,方便反复阅读。 博主主页 https://juejin.im/user/57c3970f79bc440063e58518/posts?sort=popul...

科陆李明
今天
1
0
20.27 分发系统介绍~ 20.30 expect脚本传递参数

分发系统介绍分发系统-expect讲解(也就是一个分发的脚本)场景:业务越来越大,网站app,后端,编程语言是php,所以就需要配置lamp或者lnmp,最好还需要吧代码上传到服务器上;但是因...

洗香香
今天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部