强大的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,选择文档的编码格式。

说明:编码格式,UTF-8 是首选。如果需要显示中文则选择GB2313。

图5,设置提取的范围。

图6,设置源码的格式。

图7,设置生成CHM文件属性。

图8,配置完成后,点击"Run doxygen"来运行配置,最后,点击File->Save存储配置文件,下次就不用再配置了。

4. 输出文档示例

下面的图片示例了输出的文档格式(HTML),很简单实用,同时还能支持Search。

图9,列出所有的包名。

图10,具体某一个类的详细注释,可以列出所有的公有方法,你的代码注释写得越详细,那么生成的文档也就越详细。

(0)

相关推荐

  • HyperSnap-DX 6.31.01 专业级抓图工具·强大的图像编辑工具·支持游戏和视频

    hypersnap-DX 是个屏幕抓图工具,它不仅能抓住标准桌面程序还能抓取 directx, 3Dfx Glide 游戏和视频或 DVD 屏幕图。本程序能以 20 多种图形格式(包括:BMP, GI ...

  • 雨林木风Win7系统强大的计算器工具你了解多少?

    计算器和Windows系统相伴多年,Win7正版系统自然也少不了计算器,与XP、Vista和更早的Windows系统相比,Win7正版系统计算器功能更加强大,除了简单的加、减、乘、除,还能进行更复杂的 ...

  • DM 9.57 硬盘分区工具图文教程(中文注释/含低格)

    DM9.57是维护分区硬盘常用的主要工具,可以提供简易和高级两种安装模式,简易模式适合初级用户,高级模式针为高级用户而设计,支持FAT32格式,可在一个分区上格式化大于2MB的驱动器,在高级安装模式下 ...

  • Win7系统自带的强大截图工具如何设置快捷键

    截图是大家日常不可避免的操作,无论是看到喜欢的图片想要保存还是跟朋友分享美图,我们都需要用到截图,但是大部分用户平时使用的都是qq的截图功能,其实Win7旗舰版系统自带有一款截图工具,因为使用的不便捷 ...

  • ug语言设置工具怎么用?UG10.0如何设置成中文?

    在电脑中安装UG软件的时候,在其语言选择时,明明是选的是中文,可是软件安装完成,打开却显示的是为英文,遇到这种情况,UG语言设置工具该怎么使用呢?本篇就讲解下:如何把UG10.0的英文界面变成中文:图 ...

  • 苹果电脑Mac版FTP工具Filezilla使用教程图解(附Filezilla下载)

    FTP工具对于很对编辑网管甚至工程师们来说是一个非常重要的工具,大多数时候我们需要通过FTP工具将文件上传至服务器端,这个时候一款好用且功能强大的FTP工具就弥足珍贵了。身为一个软件编辑,小编在Win ...

  • Mac FTP工具Filezilla使用教程

    FTP工具对于很对编辑网管甚至工程师们来说是一个非常重要的工具,大多数时候我们需要通过FTP工具将文件上传至服务器端,这个时候一款好用且功能强大的FTP工具就弥足珍贵了。身为一个软件编辑,小编在Win ...

  • 几种主流浏览器内置http抓包工具软件使用方法

    对于学习网站的人或者相关编程人员,经常需要用到http抓包工具来跟踪网页,但主流抓包软件如httpwatch.httpanalyzerstdv都是收费的,破解版往往也不稳定.实际上现在很多浏览器都内置 ...

  • glary utilities清理系统垃圾文件如何设置中文语言

    Glary Utilities 是国外一款非常流行的功能强大的系统工具,提供了涵盖系统优化.管理.保护和加速的所有功能,而且还是免费的,能够帮助用户轻松实现系统垃圾文件的清理.无效的注册表键值的清理. ...