自动化文档生成工具DoxyGen中文说明

DoxyGen

中文说明

需积分: 31 163 浏览量更新于2023-03-16 评论收藏 95KB DOC 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

资源详情

资源评论

资源推荐

简介 Doxygen

简介 Doxygen......................................................................................................................................1

什么是 Doxygen?................................................................................................................................1

安装 Doxygen......................................................................................................................................2

设定 Project 的 doxygen 组态........................................................................................... .............. ...2

撰写正确格式的批注.........................................................................................................................6

制作说明文件...................................................................................................................................11

什么是 Doxygen?

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明

文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，

要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。大部分有用的批注都

是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批

注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的

人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，

就是沉重的负担。

一个好的程序设计师，在写程序时，都会在适当的地方加上合适的批注。如果，

能够在撰写批注时，稍微符合某种格式，接着就可以透过一个工具程序依据程

序结构及您的批注产生出漂亮的檔。这将令许多工作繁重的程序设计师有时间

多喝几杯咖啡。

Doxygen 就是这样的一个工具。在您写批注时，稍微按照一些它所制订的规

则。接着，他就可以帮您产生出漂亮的檔了。因此，Doxygen 的使用可分为

两大部分。首先是特定格式的批注撰写，第二便是利用 Doxygen 的工具来产

生檔。

目前 Doxygen 可处理的程序语言包含：

 C/C++

 Java

 IDL (Corba, Microsoft 及 KDE-DCOP 类型)!!

而可产生出来的檔格式有：

 HTML

 XML

 LaTeX

 RTF

 Unix Man Page

而其中还可衍生出不少其它格式。如有了 LaTeX 档后，就可以透过一些工具产

生出 PS 或是 PDF 档案。

在多国语言的支持方面，Doxygen 目前可支持的约有 2,30 种。自 Doxygen

1.2.16 开始支持繁体中文(这正是小弟做的好事)。所以在目前一些 Open

Source 的程序文件产生器中，Doxygen 算是相当完整的一套。在程序语言处

理上面，Doxygen 也算是少数在 Borland C++ Builder 的语法下还能够正常

运作的工具之一（若非如此，小弟也不会推荐它）。

本文的目的是希望在经过仔细阅读本文之后能够给大家一个概略性的了解。以

便可以很容易的上手使用 Doxygen。至于 Doxygen 本身的详细使用，各位可

以参考随着 Doxygen 所附的檔。实际上，Doxygen 自己的使用手册就是使

用 Doxygen 产生的。您可以看到他实际上能够产生远比 Reference Book 更

复杂的文件。

安装 Doxygen

Doxygen 的安装可说十分的简单，本文仅介绍 binary 档案的安装，若您有兴

趣从 source code 重新 compile 起来，请自行查阅参考手册。

首先，请您先至 doxygen 的网站上面抓取最新版本的 doxygen 回来。目前，

只要您是 Linux, Solaris, Mac OS X, HP-UX, 甚至是 UnixWare，都有

compile 好的 binary 版本可以抓取。如果是 Windows

95/98/ME/NT/2000/XP，甚至还有 Setup 的版本可以抓取。所以安装过程可

说十分简单。只要给予正确的安装目录，相信一般在安装上是不会遇到什么问

题的。

另外，如果您是 Linux 或是 Windows，可以另外抓取 Doxygen Wizard 的程

序。这是一个辅助工具，可以很快的帮您建立一个 Doxygen 的组态档案。透

过这个组态档案，您就可以很快的将檔产生出来。另外，若没有使用

Doxygen Wizard，还是可以使用一般的文字编辑器将这个组态檔制作出来。

若安装成功，您应该可以看到 doxygen 这个执行文件出现在您的系统中。若

是 Windows 平台，则可看到在程序集中有 Doxygen 这个 Folder 出现。

设定 Project 的 doxygen 组态

Doxygen 产生檔可以分为三个步骤。一是为 Project 建立组态檔，二是在程

序代码中加上符合 Doxygen 所定义批注格式。三是使用 Doxygen 来产生批

注。

因此，第一步就是为您的 Project 制作 Doxygen 的组态档案。这个所谓的组

态档案，格式其实与很简单。就是一些 Key 与值的设定。每个设定为一行。若

第一行开头为"#" 表示该行为批注。Doxygen 会忽略它。每个设定行的格式

有两种，分别如下：

TAG = value [value, ...]

及

TAG += value [value, ...]

第一种形式是最常见的，也就是要设定一个 TAG (也就是一个 Key )，他的值

为右边所定义的部分。原则上每个值都是单一的英文字，如果您要定义的值有

空格符包含在内，可使用双引号将它括住。如果要定义的值超过一个以上，可

使用逗号","予以分隔开来。

如果您要定义的 TAG 是属于表列型态的，也就是他会有很多的值分别以逗号隔

开。在 Doxygen 组态檔中允许您在不同的地方重复定义。只是后面的定义应

使用上面所说的第二种形式。此种形式会将前后两个定义的值合并在一起。

知道这个基本格式后，剩下就是根据各个 TAG 的意义来进行设定。关于 TAG

的定义很多，此处我们仅针对必要用到的 TAG 进行说明，剩下的部分请自行翻

阅使用说明。

由于 Doxygen 的 TAG 还算不少，为了方便使用，Doxygen 自身提供了一个

方便的选项，可以帮您建立一份空白的 Doxygen 档案(Doxygen 是

Doxygen 预设的组态檔名)。

> doxygen Doxygen

!!!

透过这个命令，您可以得到一个 Doxygen 档案，接下来就可使用一般的文字

编辑器来进行编辑。

下面将针对几个必要的 TAG 进行说明：

PROJECT_NAME

Project 的名字，以一个单字为主，多

个单字请使用双引号括住。

PROJECT_VERSION

Project 的版本号码。

OUTPUT_DIRECTO

输出路径。产生的文件会放在这个路径

之下。如果没有填这个路径，将会以目

前所在路径来作为输出路径。

OUTPUT_LANGUAG

输出语言。预设为 English。1.2.16 版

后，您可以使用 Chinese-Traditional

剩余11页未读，继续阅读

hpccn

粉丝: 56
资源: 7

会员权益专享

自动化文档生成工具DoxyGen 中文说明

评论0

会员权益专享

最新资源

自动化文档生成工具DoxyGen 中文说明

评论0

windows下使用doxygen为C C++程序生成中文文档

自动化文档工具

自动文档生成doxygen1.5

cpp 代码注释文档自动生成

qtcreator-doxygen

hight-speed charting doxygen documentation

java主流的api文档框架

cmake 生成接口文件

c++可视化文档的揝写

doxygen使用教程

c语言代码注释自动生成工具

cicd部署doxygen

doxygen,document,vc2005

hal用户手册怎么生成

linux实验五常用开发工具

idea怎么自动生成Java类图

可视化C++函数调用关系

在QT中///注释和//注释的区别

codeblocks好用的插件

clion cmake 相关插件

会员权益专享

最新资源