doxygen小试牛刀

     今天试用了一下传说中的doxygen，用一句话概括就是：很强大，很方便！ 在sourceforge下载了最新版本1.7.2（http://sourceforge.net/projects/doxygen/files/），又在网上找了几篇介绍文档，就开工研究了。总的来说，应用其GUI的配置向导很方便，下面把小试牛刀的应用心得小结如下：

 

（1）将其所有默认的UTF-8编码，替换成GBK，以支持中文的正确显示；

 

（2）记得勾选生成chm的配置选项，并检查编译路径，如下所示：

 

GENERATE_HTMLHELP = YES

HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"

 

 

（3）doxygen支持生成的文档格式有：

l         HTML

l         XML

l         LaTeX

l         RTF

l         Unix Man Page

 

 

（4）比较常用的配置选项：

 

 

INPUT                  = . ../include         项目的路径（用空格隔开，可以用引号括起来）

HIDE_UNDOC_MEMBERS     = NO             是否需要隐藏未注释的成员

SOURCE_BROWSER         = YES             是否显示源程序

GENERATE_HTML          = YES               生成html格式的文档

GENERATE_HTMLHELP      = YES             生成chm文件

CHM_FILE               = show.chm         chm文件的名字

HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"            hhc的路径

HAVE_DOT                      = YES                      支持图形扩展

 

 

（5）为了能够使用Dot图形扩展，你需要首先安装graphviz，这是一个免费的图形库扩展，可以从http://graphviz.org 下载。下载完Dot并安装完毕之后，需要在doxygen文件中将以下选项打开：

     HAVE_DOT = YES

  

      总之，有了doxygen的支持后，从软件代码到项目文档的转化十分简单，在源码文件中按指定格式写好注释，然后，运行一下doxygen代码的说明文档就方便快捷的输出了。这对于一些中、大型多人协作开发的项目，尤其有用！