资源描述：
《doxygen讲解.ppt》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。
1、目录使用Doxygen的目的.安装Doxygen所需工具.配置DoxygenDoxygen注释风格使用Doxygen的目的生成模块文档，方便以后维护模块代码。提高代码可读性。提高项目代码的管理。省略了自己写readme文件（或文档）。安装Doxygen所需工具Doxygen(版本:1.5.2)Graphviz(版本:2.12)iconv(GNUlibiconv1.9)fr(版本:2.1.1.120)HTMLHelpWorkshop(版本:4.74.8702.0)(注:这些工具放在\dataserver开发二部
2、开发二部_公共盘白盒测试相关生成文档工具)安装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
3、.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:WINDOWSsystem32”；3.安装完成；注:上面安装能够运行成功,但是出现一个问题.就是我们编译下载环境模块时iconv的cygwin1.dll文件名明与cygwin的cygwin1.dll文件名相同导致的.所以编译不通过.解决方法:
4、在下页.安装iconv、fr工具解决方案新建一个系统变量名为”GBK”,这我固定了.所以都以这个名字.这个就是要放置iconv、fr工具里文件的路径.(这个路径随自己编写)、安装HTMLHelpWorkshop工具1.双击运行htmlhelp.exe;2.安装软件提示语操作即可;3.HTMLHelpWorkshop安装完成;注：HTMLHelpWorkshop工具要安装在这个路径“X:ProgramFilesHTMLHelpWorkshop”（X：自己指定）.附带操作为了方便运行Doxygen工具与管理.为每
5、个模块创建一文件夹(如：“TEST”),在TEST文件夹里再创建src、doc文件夹。Src文件夹存放源文件，doc文件夹存放Doxygen输出文件。顺便把doxygenWD.bat和Doxygen配置文件“Doxyfile”拷贝到doc文件夹下，如果要生成文档就双击doxygenWD.bat即可。（模块的目录结构如下）注:Doxygen不支持中问路径,不要创建中文路径.TEST
6、----src
7、
8、
9、
10、----test.c
11、
12、----test.h
13、
14、----doc
15、
16、
17、
18、----Doxyfile
19、
20、----dox
21、ygenWD.bat配置Doxygen分为两种:①向导(Wizard)模式：将快速配置大多数重要设定,其他选项保持默认值。②专家(Expert)模式：进入全部的配置选项。向导(Wizard)模式向导(Wizard)对话框----Project相关选项项目名称，将作为于所生成的程序文档首页标题.文档版本号，可对应于项目版本号.存放要生成项目文档的项目源文件路径.如果选上，就会连子文件夹的文件一起生成文当。没选，就只会生成本文件夹的文件文档.这里填入生成文档文件输出路径,这里只填文件夹名字就可以了.为了大家工作方便,
22、就规定统一写output文件夹向导(Wizard)模式向导(Wizard)对话框----Mode相关选项选择这个,只生成文档实体,不会生成源文件文档.选择这个,会生成全部实体.因此,要选择这个.选择这个,把源文件内容导入到项目文档里.(建议选择)选择项目文档输出格式,测试C语言,就选择个.向导(Wizard)模式向导(Wizard)对话框----Output相关选项生成普通模式的HTML生成文件列表格的HTML生成chm文件格式的HTML,因此,就选这个.附带查找功能,一般不选择.这项没用到,因此把它选择取消.这
23、三项不要选择向导(Wizard)模式向导(Wizard)对话框----Diagrams相关选项这两个不选择.全选择.通过这个GraphViz工具生成图表:(1).类的图表.(2).协作图表.(3).包含文件图表(调用图表).(4).被包含文件图表(被调用图表).(5).整个类层次结构图表.(6).调用图表(函数,文件).专家(Expert)模式由于经过向导(Wizard)
