《doxygen标准VC注释_完整的配置步骤》由会员分享，可在线阅读，更多相关《doxygen标准VC注释_完整的配置步骤（32页珍藏版）》请在金锄头文库上搜索。
1、C+ 程序文档生成器介绍(doxygen) 程序文档，曾经是程序员的一个头痛问题。写一个程序文档，比较花时间，但不是很难；麻烦的是当程序修改后，程序文档也要跟着同步更新，否则文档和程序就要脱节，文档也就变成没用的东西了。好在有许多好用的文档生成器来解决这个问题。目前比较流行的 C+文档生成器是 doxygen。本文就简单的介绍一下 doxygen 的文档注释方法，以供初学者参考：1. 模块定义（单独显示一页）/* defgroup 模块名 模块的说明文字* */. 定义的内容 ./* */ / 模块结尾2. 分组定义（在一页内分组显示）/* name 分组说明文字* */. 定义的内容 ./*
2、 */3. 变量、宏定义、类型定义简要说明/* 简要说明文字 */#define FLOAT float/* brief 简要说明文字（在前面加 brief 是标准格式） */#define MIN_UINT 0 /* 分行的简要说明 n* 这是第二行的简要说明*/int b;4. 函数说明/* 简要的函数说明文字 * param in param1 参数 1 说明* param out param2 参数 2 说明* return 返回值说明*/int func(int param1, int param2);/* 打开文件 n* 文件打开成功后，必须使用 :CloseFile 函数关闭。*
3、 paramin file_name 文件名字符串* paramin file_mode 文件打开模式字符串，可以由以下几个模块组合而成：* - r 读取* - w 可写* - a 添加* - t 文本模式(不能与 b 联用)* - b 二进制模式(不能与 t 联用)* return 返回文件编号* - -1 表示打开文件失败* note 文件打开成功后，必须使用 :CloseFile 函数关闭* par 示例:* code/ 用文本只读方式打开文件int f = OpenFile(d:test.txt, rt);* endcode* see :ReadFile :WriteFile :Clo
4、seFile* deprecated 由于特殊的原因，这个函数可能会在将来的版本中取消。*/int OpenFile(const char* file_name, const char* file_mode);5. 枚举类型定义/* 枚举常量 */typedef enum TDayOfWeekSUN = 0, /*菜单中运行). 下面就对我个人认为比较重要的选项,并结合实例 (生成 html 文档) 进行简单说明.下面列出的一般是需要修改的,未列出的我采用缺省值.# Project 选项#-# Staff_TPC 是生成文档的项目名 ,会显示在文档中.PROJECT_NAME = Staff_
5、TPCPROJECT_NUMBER = 1.0 # 项目版本号# 生成文档的输出路径OUTPUT_DIRECTORY = f:/My Documents/cpp/horin/staff/# 生成文档的语言,缺省是 English,也可以是简体中文等.OUTPUT_LANGUAGE = EnglishJAVADOC_AUTOBRIEF = YES # 打开此选项.# Build 选项#-SHOW_INCLUDE_FILES = NO # 不显示所有包括的文件.# input 选项#-# 要生成文档的源文件的路径. 如果是一个目录,则是该目录下的所有文件; 当然,也可以# 是具体的某个文件.INP
6、UT = f:/My Documents/cpp/horin/staff/tpc/# 输入文件的匹配模式,下面是 c / c+语言的设置.FILE_PATTERNS = *.c *.cpp *.h *.hppRECURSIVE = YES # 需要递归处理子目录.# source browser 选项#-# 如为 SOURCE_BROWSER 和 INLINE_SOURCES 都设置为 YES, 则生成的文档中会包括源代码# (即.cpp 文件),这可以方便阅读时查看源代码 .SOURCE_BROWSER = NOINLINE_SOURCES = NOSTRIP_CODE_COMMENTS =
7、 YES # 忽略普通的文档注释 .REFERENCED_BY_RELATION = YESREFERENCES_RELATION = YESVERBATIM_HEADERS = YES# HTML 选项#-GENERATE_HTML = YES # 需要生成 html 格式的文档.GENERATE_HTMLHELP = YES # 需要生成 windows HTMLHELP 格式的目录,以方便阅读.GENERATE_TREEVIEW = YES # 需要生成树视图,以方便阅读.# LaTeX 选项#-GENERATE_LATEX = NO # 不需要生成 LaTeX 输出.# dot 选项
8、# 此选项是生成图形 ,建议(需要)安装 graphviz.#-CLASS_DIAGRAMS = YESHIDE_UNDOC_RELATIONS = YESHAVE_DOT = YES # 已经安装 graphviz.打开此选项.CLASS_GRAPH = YES # 生成类图COLLABORATION_GRAPH = YES # 生成协作图UML_LOOK = NO 在上面根据自己的需要对各个选项进行了配置,下面很重要的一步,就是把配置保存下来. 呵呵,这是大家最擅长的了. 可以命名配置文件为 Doxygen-YourName.txt, 今后只需修改project 和 input 选项,即可
9、重用.8. 项目符号标记/* * A list of events:* - mouse events* -# mouse move event* -# mouse click eventn* More info about the click event.* -# mouse double click event* - keyboard events* -# key down event* -# key up event* More text here.*/结果为： A list of events: mouse events a. mouse move event b. mouse clic
10、k eventMore info about the click event. c. mouse double click eventkeyboard events d. key down event e. key up eventMore text here.代码示范： /* defgroup EXAMPLES 自动注释文档范例 * author 沐枫* version 1.0* date 2004-2005* */* name 文件名常量* */* 日志文件名 */#define LOG_FILENAME d:logdebug.log/* 数据文件名 */#define DATA_FILE
11、NAME d:datadetail.dat/* 存档文件名 */#define BAK_FILENAME d:databackup.dat/* */ / 文件名常量/* name 系统状态常量* */* 正常状态 */#define SYS_NORMAL 0/* 故障状态 */#define SYS_FAULT 1/* 警告状态 */#define SYS_WARNNING 2/* */ / 系统状态常量/* 枚举常量 */typedef enum TDayOfWeekSUN = 0, /* doxygen Doxygen透过这个命令，您可以得到一个 Doxygen 档案，接下来就可使用一般的
12、文字编辑器来进行编辑。下面将针对几个必要的 TAG 进行说明：PROJECT_NAME Project 的名字，以一个单字为主，多个单字请使用双引号括住。PROJECT_VERSION Project 的版本号码。OUTPUT_DIRECTORY 输出路径。产生的文件会放在这个路径之下。如果没有填这个路径，将会以目前所在路径来作为输出路径。OUTPUT_LANGUAGE 输出语言。预设为 English。1.2.16 版后，您可以使用 Chinese-Traditional 来输出中文繁体的格式。INPUT 指定加载或找寻要处理的程序代码档案路径。这边是一个表列式的型态。并且可指定档案及路径。
13、举例来说若您有 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 类似于 FILE_PATTERNS
