使用doxygen生成代码工程文档并显示相关注释

1 环境准备

工具链接地址：

 

链接：http://pan.baidu.com/s/1slowLaP 密码：d7j5 

 

说明：

 

工具文件	使用说明
doxygen-1.5.2-setup.exe	Doxyge，安装即可。
graphviz-2.12.exe	图形可视化软件，安装即可。
htmlhelp.exe	用于生成CHM文件，安装即可
iconv.rar	编码转换，按后文说明使用。
fr.rar	命令行查找替换工具，按后文说明使用。
doxybat.zip	批处理文件，解压后按后文说明使用。

 

建立一个空目录xxx，放入要注释的程序（xxx\src），建立制作文档的工作目录（xxx\doc），将前面介绍的批处理文件放到doc目录。

2 批处理文件使用说明

说明：将批处理文件放在工作目录（doc目录：即Doxyfile所在目录）后，每次只要键入rebuild就可以重新生成chm文件。必要时可以单独使用clean、build、makechm命令。utf82gbk和html-utf82gbk命令也可以单独使用。

2.1 clean.bat

作用：清空之前的输出文件

 

@echo off echo 清空以前输出 if exist refman.chm del /f /q refman.chm if exist output\html del /f /q output\html\*.* if exist output\latex del /f /q output\latex\*.* if exist output\rtf del /f /q output\rtf\*.* if exist output del /f /q output\*.*

2.2 build.bat

作用：调用doxygen生成文档

 

@echo off echo 生成文档 doxygen Doxyfile

2.3 utf82gbk.bat

作用：将指定文件（支持通配符）从utf-8编码转换到gbk编码

 

@echo off echo 将%1从utf-8编码转换到gbk编码 for %%f in (%1) do copy %%f %%f.utf8 for %%f in (%1) do iconv -c -f utf-8 -t gbk %%f.utf8 > %%f

 

这个批处理文件要求系统当前路径上有iconv.exe。执行iconv时，使用-c参数忽略无法转换的字符。否则如果输入文件包含无法转换的字符，转换会失败。输入文件被备份到加过