doxygen讲解.pptVIP

目录 使用Doxygen的目的. 安装Doxygen所需工具. 配置Doxygen Doxygen注释风格 使用Doxygen的目的 生成模块文档，方便以后维护模块代码。 提高代码可读性。 提高项目代码的管理。 省略了自己写readme文件（或文档）。 安装Doxygen所需工具 Doxygen(版本:1.5.2) Graphviz(版本: 2.12) iconv (GNU libiconv 1.9) fr(版本: 2.1.1.120) HTML Help Workshop (版本:4.74.8702.0) (注:这些工具放在 \\dataserver\开发二部\开发二部_公共盘\白盒测试相关\生成文档工具 ) 安装Doxygen工具 1.先解压doxygen.rar; 2.双击运行 doxygen-1.5.2-setup.exe; 3.安装软件提示语操作即可; 4.把create_chm.bat、html_foot拷贝到Doxygen安装目录的bin文件夹里. 5.把 Doxygen安装目录的bin路径放在系统环境变量里; 6.Doxygen安装完成; 安装Graphviz工具 1.先解压graphviz.rar； 2.双击运行graphviz-2.12.exe； 3.安装软件提示语操作即可； 4. Graphviz安装完成； 安装iconv、 fr工具 1.先解压iconv.rar和fr.rar； 2.将iconv.rar和fr.rar分别解压出来的 cygiconv-2.dll、cygintl-2.dll、cygwin1.dll、 iconv.exe和fr.exe拷到“C:\WINDOWS\system32”； 3.安装完成； 注:上面安装能够运行成功,但是出现一个问题.就是我们编译下载环境模块时iconv的cygwin1.dll文件名明与cygwin的cygwin1.dll文件名相同导致的.所以编译不通过. 解决方法:在下页. 安装iconv、 fr工具解决方案 安装HTML Help Workshop工具 1.双击运行 htmlhelp.exe; 2.安装软件提示语操作即可; 3. HTML Help Workshop安装完成; 注： HTML Help Workshop工具要安装在这个路径“X:\Program Files\HTML Help Workshop”（X：自己指定）. 附带操作 为了方便运行Doxygen工具与管理.为每个模块创建一文件夹(如：“TEST”),在TEST文件夹里再创建src、doc文件夹。Src文件夹存放源文件，doc文件夹存放Doxygen输出文件。顺便把doxygenWD.bat和Doxygen配置文件“Doxyfile” 拷贝到doc文件夹下，如果要生成文档就双击doxygenWD.bat即可。（模块的目录结构如下 ） 注:Doxygen不支持 中问路径,不要创建 中文路径. 配置Doxygen 分为两种: ①向导(Wizard)模式：将快速配置大多数重要设定, 其他选项保持默认值。 ②专家(Expert)模式：进入全部的配置选项。 向导(Wizard)模式 向导(Wizard)对话框----Project相关选项 向导(Wizard)模式 向导(Wizard)对话框----Mode相关选项 向导(Wizard)模式 向导(Wizard)对话框----Output相关选项 向导(Wizard)模式 向导(Wizard)对话框----Diagrams相关选项 专家(Expert)模式 由于经过向导(Wizard)模式快速的配置，所以专家(Expert)模式大部分也相应配置好了。 那么，下面主要配置细节问题，其他就不详细介绍都保持默认选择就可以。 专家(Expert)模式 专家(Expert)对话框----Project相关选项 专家(Expert)模式 专家(Expert)对话框----Project相关选项 专家(Expert)模式 专家(Expert)对话框----Messages相关选项 专家(Expert)模式 专家(Expert)对话框----Input相关选项 专家(Expert)模式 专家(Expert)对话框----Messages相关选项 专家(Expert)模式 专家(Expert)对话框----Dot相关选项 Doxygen注释风格 Doxygen指令目的为了生成更丰富与可读性更强的文档。所以总结5类常用的注释风格说明。 ●变量、宏定义、类型定义。 ●枚举类型定义、结构