Doxygen简介&安装篇
一、什么是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(win环境)。
首先下载三个软件,均下载windows下的安装包,
地址如下:
doxygen:http://sourceforge.net/projects/doxygen/ 我用的最新版1.7.6.1
Graphviz :http://www.graphviz.org/Download..php 记得选择windows下的版本哟http://static.blog.csdn.net/xheditor/xheditor_emot/default/tongue.gif “Stable and development Windows Install packages”
htmlhelp:http://www.softpedia.com/get/Authoring-tools/Help-e-book-creators/HTML-Help-Workshop.shtml
首先安装Graphviz ,再安装doxygen,安装没什么,一路next就ok了
下面就讲解下如何使用了
运行doxygen的步骤和基本界面如下图,
http://hi.csdn.net/attachment/201112/30/0_1325220422vxkF.gif
http://hi.csdn.net/attachment/201112/30/0_1325220454AV61.gif
http://hi.csdn.net/attachment/201112/30/0_13252204729sy5.gif
http://hi.csdn.net/attachment/201112/30/0_1325220484ww1Y.gif
http://hi.csdn.net/attachment/201112/30/0_13252205002u28.gif
http://hi.csdn.net/attachment/201112/30/0_132522051666fe.gif
以上运行完毕就已经生成了相应的html文档页面,如果不需要chm文档,那就不用往下看了,赶紧去试试吧http://static.blog.csdn.net/xheditor/xheditor_emot/default/laugh.gif
多谢楼主分享,先mark 好文,不过为什么发在GoKit版?:lol
页:
[1]