首页 > 学院 > 开发设计 > 正文

Doxygen 安装配置

2019-11-08 01:21:09
字体:
来源:转载
供稿:网友

1. Doxygen

Doxgen就是大名鼎鼎的文档生成工具,而且是免费开源的,它使用非常方便,能提取C++,java,Objective-C,Python,IDL,php,C#等语言的注释,从而生成文档。

你可以访问其官方网站,下载安装包,它的官网上有详细的使用手册。

http://www.doxygen.nl/index.html

支持的主要语言格式

ExtensionLanguage
.idlIDL
.ddlIDL
.odlIDL
.javaJava
.csC#
.cC
.cppC++

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

HTMLxmlLaTeXRTFCHM 

要让工具能提取注释,那么就要求你写的注释要按照一定的规则来写,不能乱写,不然该工具是无法识别的,通常在Java中,只要JavaDoc能识别的,doxgen也能识别。

2. 安装Doxygen

我们可以在这个网址去下载最新的安装包

http://www.doxygen.nl/download.html#latestsrc

安装过程就不用说了,很简单,直接Next,最后Finish就OK了。

3. 配置Doxygen

配置doxgen是最核心的,你可以设置你要提取注释的源文件,生成的文档格式,工程名称,文档的Logo等信息,这些配置是可以存储起来的,当你的源代码更新后,重新再运行这个配置文件,就可以重新生成一个新的文档。

在安装后,进入到其安装目录下的bin文件夹,它里面有两个文件:doxygen.exe和doxywizard.exe,我们先运行doxywizard.exe来进行配置,从而生成配置文件(如果是第一次运行)。

图1,Doxygen配置主界面。

1,Doxygen工作目录,就是用来存储配置文件的目录。

2,递归搜索目录需要选上。

图2,选择输出文档格式

图3,生成类图

图4,选择文档的编码格式。

说明:编码格式,UTF-8 是首选。如果需要显示中文则选择GB2313。

图5,设置提取的范围。

图6,设置源码的格式。

图7,设置生成CHM文件属性。

图8,配置完成后,点击"Run doxygen"来运行配置,最后,点击File->Save存储配置文件,下次就不用再配置了。

参考文章:http://blog.csdn.net/leehong2005/article/details/9137889

软件获取QQ:728297725


发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表