首页 > Windows开发 > 详细

Doxygen + Graphviz windows+Windows Help Workshop下安装配置(图解)

时间:2015-11-17 23:30:05      阅读:622      评论:0      收藏:0      [点我收藏+]

一.什么是Doxygen?

Doxygen 是一个程序的文件生工具,可将程序中的特定批注转换为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成个纯粹的参考手册于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。
Doxygen 就是在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文档了。

因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰,第二便是利用Doxygen的工具来产生文档

目前Doxygen可处理的程序语言包含:

· C/C++

· Java

· IDL (Corba, Microsoft及KDE-DCOP类型)   

而可产生出来的文档格式有:

· HTML

· XML

· LaTeX

· RTF

· Unix Man Page

而其中还可衍生出不少其它格式。HTML可以打包成CHM格式,而LaTeX可以透过一些工具产生出PS或是PDF文档。

 

二.安装Doxygen

· 1.1 安装 Doxygen 1.7.4(Windows) 

· 1.2 安装 graphviz 2.28.0(Windows)

graphviz 是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图,如不需要此功能可不安装该工具包。

· 1.3 安装 Windows Help Workshop 1.32

Doxygen 使用这个工具可以生成 CHM 格式的文档。


具体配置图文说明如下:

http://blog.csdn.net/fly542/article/details/7164633

谢谢楼主的这篇文章,很容易就上手生成了html文档。只是在其中遇到一点问题,我如果完全按照楼主的设置来运行脚本,生成的html文档中的图片是无显示的,查看Log发现Doxygen运行的时候提示了一句:"warning: the dot tool could not be found at C:\Program Files (x86)\Graphviz2.38",经过反复试验,将DOT PATH路径修改为:"C:\Program Files (x86)\Graphviz2.38\bin"则在生成的html文档中可以正常看到函数调用关系图片了。另外,楼主后面的生成chm文档的步骤为何没有呢。。。同样需要。毕竟html不方便传输携带。。。;)

http://blog.csdn.net/chenyujing1234/article/details/19115319





版权声明:本文为【借你一秒】原创文章,转载请标明出处。

Doxygen + Graphviz windows+Windows Help Workshop下安装配置(图解)

原文:http://blog.csdn.net/u013467442/article/details/49894207

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!