可以看到 doxygen 这个执行文件出现在您的系统中。
若是Windows 平台,则可看到在程序集中有 Doxygen 这个 Folder 出现。
设定 Project 的 doxygen 组态Doxygen 产生档可以分为三个步骤。
一是为 Project 建立组态档,二是在程序代码中加上符合 Doxygen 所定义批注格式。
三是使用 Doxygen 来产生批注。
因此,第一步就是为您的 Project 制作 Doxygen 的组态档案。
这个所谓的组态档案,格式其实与很简单。
就是一些 Key 与值的设定。
每个设定为一行。
若第一行开头为quotquot 表示该行为批注。
Doxygen 会忽略它。
每个设定行的格式有两种,分别如下:TAG value value ...及TAG value value ...第一种形式是最常见的,也就是要设定一个 TAG 也就是一个 Key ,他的值为右边所定义的部分。
原则上每个值都是单一的英文字, 如果您要定义的值有空格符包含在内,可使 用双引号将它括住。
如果要定义的值超过一个以上,可使用逗号quotquot予以分隔开来。
如果您要定义的 TAG 是属于表列型态的,也就是他会有很多的值分别以逗号隔开。
在 Doxygen 组态档中允许您在不同的地方重复定义。
只是后面的定义应使用上面所说的第二种形式。
此种形式会将前后两个定义的值合并在一起。
知道这个基本格式后,剩下就是根据各个 TAG 的意义来进行设定。
关于 TAG 的定义很多,此处我们仅针对必要用到的 TAG 进行说明,剩下的部分请自行翻阅使用说明。
由于 Doxygen 的 TAG 还算不少,为了方便使用,Doxygen 自身提供了一个方便的选项,可以 帮您建立一份空白的 Doxygen 档案Doxygen 是 Doxygen 预设的组态档名。
gt doxygen Doxygen透过这个命令,您可以得到一个 Doxygen 档案,接下来就可使用一般的文字编辑器来进行编辑。
下面将针对几个必要的 TAG 进行说明:PROJECT_NAME Project 的名字,以一个单字为主,多个 单字请使用双引号括住。
PROJECT_VERSION Project 的版本号码。
OUTPUT_DIRECTORY 输出路径。
产生的文件会放在这个路径之 下。
如果没有填这个路径,将会以目前所 在路径来作为输出路径。
OUTPUT_LANGUAGE 输出语言。
预设为 English。
1.2.16 版后, 您可以使用 Chinese-Traditional 来输 出中文繁体的格式。
INPUT 指定加载或找寻要处理的程序代码档案路 径。
这边是一个表列式的型态。
并且可指 定档案及路径。
举例来说若您有 a.c b.c c.c 三个档案。
您可使用 INPUT a.c b.c c.c 的方式。
若您给定一个目录,该 目录下面所有档案都会被处理。
FILE_PATTERNS 如果您的 INPUT Tag 中指定了目录。
您可 以透过这个 Tag 来要求 Doxygen 在处理时, 只针对特定的档案进行动作。
例如:您希 望对目录下的扩展名为.c .cpp 及.h 的档 案作处理。
您可设定 FILE_PATTERNS .c .cpp .h。
RECURSIVE 只 这是一个布尔值的 Tag,接 受 YES 或 NO。
当设定为 YES 时,INPUT 所指定目录的所 有子目录都会被处 理。
EXCLUDE 如果您有某几个特定档案或是目录,不希 望经过 Doxygen 处理。
您可在这个 Tag 中 指定。
EXCLUDE_PATTERNS 只是.
上一篇:
ReadMetxt_VC 托盘图标的添加与删除_界面编程_新兴源码下载
下一篇:
谈加强高等院校教师的思想道德建设