Win7下Doxygen配置与使用
1. 下载与安装
1.1 下载
Doxygen官方安装程序及其手册下载地址,目前使用版本为1.8.8。
安装程序:http://www.stack.nl/~dimitri/doxygen/download.html
图 1-1 Doxygen安装程序下载界面
在线帮助:http://www.stack.nl/~dimitri/doxygen/manual
图 1-2 Doxygen帮助文档下载界面
GraphViz Doxygen官方安装下载地址及其在线帮助地址,目前使用版本为2.38。
安装程序:http://www.graphviz.org/pub/graphviz/stable/windows/
图 1-3 GraphViz安装程序下载界面
在线帮助:http://www.graphviz.org/Documentation.php
图 1-4 GraphViz在线帮助界面
1.2 安装
以上两个安装程序可以任意安装,但是一定要记住Graphviz的安装路径,Doxygen的设置中要使用此路径以生成调用关系图。
2. Doxygen配置与使用
2.1 基础配置
Doxygen的配置向导可以完成项目路径、工作模式、输出文档、图片工具四个方面的简要配置。
在图2-1中展示了项目路径配置的相关内容:其一,可以设置项目的名称、概述、版本号和项目标志;其二,可以设置源代码所在路径,递归扫描指是否将子文件夹加入源码搜索路径;其三,可以设置代码文档的输出路径,html、rtf等不同格式的代码文档以相应的文件夹存储在此路径之下。
图 2-1 项目配置
在图2-2所示的工作模式配置中,可以设定代码文档中的内容,即包括所有实体还是仅包括标记的实体。除此之外,还要手动选择Doxygen的运行时优化方案,这里选择了针对C语言和PHP的优化选项。
图 2-2 工作模式配置
在图2-3中,选择了输出HTML和RTF格式的代码文档,其中还可以设置HTML代码文档的输出内容,包括纯HTML文档、左侧带有导航树的HTML文档以及CHM文件支持,还可以更改HTML文档的配色方案。
图 2-3 输出代码文档设置
在图2-4所示的界面中,可以自由设置输出文档中是否含有图片、使用Doxygen内置图片工具生成图片、使用GraphViz生成图片三种方式。
图 2-4 图片工具设置
2.2 高级配置
高级配置是对基础配置的进一步细化,以形成不同风格的注释文档。由于涉及参数较多,本文并未给出所有参数的说明,这里仅介绍重要的参数,未尽部分还请读者自行阅读窗口左侧靠下的参数说明(详见图 25左侧红色矩形框所标识的区域)。
图2-5~图2-7完成了项目的详细配置,请注意输出语言一定要选择Chinese,一定要勾选图2-6中的JAVADOC_AUTOBRIEF选项和图2-7中的MARKDOWN_SUPPORT、AUTOLINK_SUPPORT选项,依次表示支持JavaDoc风格注释、Markdown标记方法、注释实体自动链接三种功能。
图 2-5 项目配置一
图 2-6 项目配置二
图 2-7 项目配置三
图2-8中则展示了Doxygen运行时所抽取的内容,一般采用默认设置,也可结合需求根据参数说明自行修改。
图 2-8 代码文档中包含的内容
在图2-9中,用户可以自定义Doxygen的运行日志所显示的内容与方式,可以通过运行日志检查注释的正误。
图 2-9 Doxygen运行日志的显示内容和格式
图2-10和图2-11依次说明了源码搜索路径、示例代码搜索路径和外部图片搜索路径的设置,这里一定要注意源码的编码格式设置为GBK。一旦文件编码格式有误,代码文档中就会出现乱码。
图 2-10 输入设置一——源码路径与编码格式
图 2-11 输入设置二——示例代码和图片的搜索设置
可以通过图2-12实现代码文档与源文件之间的交叉引用,方便阅读,一般使用默认设置。
图 212 源码与文档交叉引用设置
利用图2-13中索引方法设置,可以实现代码文档中的各注释对象的出现顺序,即按照字母顺序或者先后顺序显示。
图 2-13 索引方法设置
图2-14和图2-15分别展示了HTML文档、CHM文档的设置方法,其中CHM文档的生成需要HHC编译器,一般的路径为C:\Program Files\HTML Help Workshop。
图 2-14 HTML文档设置
图 2-15 CHM文档设置
代码的RTF文档设置如图图2-16,如果是小型项目最好勾选COMPACT_RTF选项,据说可以使得文档更紧凑。如果选中RTF_HYPERLINKS选项,则在RTF文档中会以链接的形式显示注释的对象。另外,如果RTF文档中的页码不能正常显示,请使用WORD中的更新域的命令更新文档即可。
图 2-16 RTF文档设置
通过图2-17所示的界面,在选择了GraphViz的路径之后,可以设置GraphViz生成图片的种类。
图 2-17 GraphViz的图片选项和路径设置
至此,已经完成Doxygen的所有设置,可以利用【File】和【Settings】菜单保存现有设置、导入已有配置等功能。
2.3 运行Doxygen
Doxygen的运行界面如图2-18所示,可以在该界面生成代码文档、显示结果和配置文件、保存日志等功能。
图 2-18 Doxygen的运行界面
请注意,如果Doxygen的运行窗口出现错误或者警告,请仔细阅读并找出问题所在,修改注释后即可。
另外,再次申明:如果RTF文档中不能正确显示页码,请对整篇文档使用"更新域"操作。
Win7下Doxygen配置与使用的更多相关文章
- win7下IIS配置以及域名映射方法
win7下IIS配置以及域名映射方法 第一步:打开控制面板,选择程序与功能,如下图: 第二步:双击打开程序与功能面板,如下图: 第三步:打开”打开或关闭windows功能”(红线圈起来的地方),如下图 ...
- (转)NoSQL——Redis在win7下安装配置的学习一
NoSQL——Redis在win7下安装配置的学习一 有些也是从网上看来的 1.下载安装 Redis它没有windows的官方版本,但是又非官方的版本,到官网上去下载相应的版本,我的电脑是win7 ...
- Win7下安装配置gVim
本文根据vim官网的<Simple Steps to Help You Install gVim on Windows 7>[1]一文整理而成. 1. 下载gVim 在http://www ...
- win7下安装配置tomcat,java运行环境
转 http://www.cnblogs.com/pannysp/archive/2012/03/07/2383364.html 1.下载JDK,安装 官网下载地址:http://java.sun.c ...
- (转载+新增)Win7下安装配置gVim
转载自 http://www.cnblogs.com/zhcncn/p/4151701.html.而后安装过程中加入自己遇到的问题解决方案. 本文根据vim官网的<Simple Steps to ...
- win7下安装配置nodejs、使用npm安装express
1.下载node http://nodejs.cn/download/ 这里下载自己需要的 我的环境是win764,下载地址是:https://nodejs.org/dist/v6.2.0/win-x ...
- Nginx+php+fastcgi在win7下的配置
首先装载php 1.从www.php.net上下载php对应版本 2.解压之后放到c盘下(其实放哪无所谓,Apache会有配置指向,但是Nginx不用) 3.因为用的5.3.17版本,已经有了php- ...
- cocos2d 2.2.6 win7下的配置
我搭建cocos2.6的开发环境需要安装工具包括: 1.Visual Studio 2012(由于不兼容win7,需要安装Update 4)和虚拟光驱daemon tool,虚拟光驱的下载地址:htt ...
- cocos2d 3.6 win7下的配置
我搭建cocos2.6的开发环境需要安装工具包括: 1.Visual Studio 2012(由于不兼容win7,需要安装Update 4)和虚拟光驱daemon tool,虚拟光驱的下载地址:htt ...
随机推荐
- 命名空间“System.Web”中不存在类型或命名空间名称“Optimization”(是否缺少程序集引用?)
今天,在.net4.5,mvc4下新建了个区域,运行起来就报这个错误: 命名空间"System.Web"中不存在类型或命名空间名称"Optimization"( ...
- Ms sql 2005 中的bit 数据类型
bit 整型数据 1.0 或 NULL(在表中的表现形式). 注释: 不能对 bit 类型的列使用索引. Microsoft® SQL Server™ 优化用于 bit 列的存储.如果一个表中有不多于 ...
- C++ 中的sort排序用法
STL中就自带了排序函数sortsort 对给定区间所有元素进行排序 要使用此函数只需用#include <algorithm> sort即可使用,语法描述为:sort(begin,end ...
- ElasticSearch作为Windows服务启动
由于公司服务器用的Windows服务器,所以你懂得…… 直接下载elasticsearch中文发行版.下载地址是:https://github.com/medcl/elasticsear ...
- nginx----------------环境搭建遇到的一些问题汇总--(多域名配置,配置文件修改问题)
nginx的启动命令是:(通用) /usr/local/nginx/sbin/nginx -c /usr/local/nginx/conf/nginx.conf 重启命令: /usr/local/ng ...
- NLog输出目标及类型
targets:输出目标节点 target:配置一个输出目标 Type输出类型: Console 输出到控制台 Debugger 输出到VS输出窗口 File 输出 ...
- chartControl绑定数据源
private void BindChartControl(DataTable dataTable,ChartControl chartControl,int[] columnNO,ViewType ...
- Hdu 2845 Beans
Beans Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 32768/32768 K (Java/Others)Total Submi ...
- linux下flash的安装
linux的初学者可能会遇到各种各样的问题,其中的问题就有一个,linux下的flash插件怎么安装呢? 首先前往flash官网下载好对应的文件,然后提取里面的一个叫做 libflashplayer. ...
- [SublimeText] 安装包管理
由于各种访问原因,因此记录一下给自己使用,原文地址如下: http://www.bonusbits.com/wiki/HowTo:Setup_Package_Control_for_Sublime_T ...