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文档中不能正确显示页码,请对整篇文档使用"更新域"操作。

时间: 2024-10-09 22:01:09

Win7下Doxygen配置与使用的相关文章

win7下安装配置tomcat,java运行环境

1.下载JDK,安装 官网下载地址:http://java.sun.com/javase/downloads/index.jsp 下载后,安装,选择你想把JDK安装的目录: 比如:JDK安装目录:E:\java 其他博文有说还要装JRE,其实JDK安装好了,就不需要安装JRE了,本身就有了. 2.设置JDK环境变量 右击“计算机”,点击“属性”,点击弹出界面的左部分的“高级系统设置”,选择“高级”选项卡,点击下部的“环境变量” 新建2个变量,编辑1个变量,分别填入以下信息,如图所示: 新建: 变

(转)NoSQL——Redis在win7下安装配置的学习一

NoSQL——Redis在win7下安装配置的学习一 有些也是从网上看来的 1.下载安装 Redis它没有windows的官方版本,但是又非官方的版本,到官网上去下载相应的版本,我的电脑是win7下的64位系统,下载的是2.4.5版本的 http://code.google.com/p/servicestack/wiki/RedisWindowsDownload#Download_32bit_Cygwin_builds_for_Windows 然后直接解压就可以了. 我直接剪切64bit文件夹到

win7下bugzilla配置

一.MYSQL安装. 1.下载并安装mysql.安装过程中,需要设定root的密码.安装完毕后,从开始中点击mysql 5.5 command line client,会让输入password,输入当时设定的password,即可开始使用mysql. 2.创建bugs数据库及[email protected]用户. 使用命令: create database bugs; //创建数据库bugs. create user [email protected];    //创建用户[email pro

Win7下安装配置gVim

本文根据vim官网的<Simple Steps to Help You Install gVim on Windows 7>[1]一文整理而成. 1. 下载gVim 在http://www.vim.org/download.php/pc 下找到“PC: MS-DOS and MS-Windows”,下载“gvim74.exe”[2]. 2. 安装gVim 1. 安装时可以选择更改目录(文中在 Users/用户名 下面新建了一个目录Vim,将gVim安装在了该目录下). 2. 安装时注意选择‘F

win7下安装配置tomcat

下载Tomcat,官网上下载的文件都是绿色免安装的.如:apache-tomcat-7.0.26-windows-x64.zip 下载地址:http://tomcat.apache.org/download-70.cgi 下载后解压缩:E:\apache-tomcat-7.0.26,随你喜欢解压哪里.   4.设置Tomcat环境变量   新建: 变量名:TOMCAT_HOME 变量值:你的TOMCAT所在目录 如:E:\apache-tomcat-7.0.26   现在环境基本都搭建好了,可以

BA-siemens-insight在win7下如何配置opc接口

一.运行环境:win7(OPC接口在win_xp下配置需安装插件,不好意思没搞定,现在只有win7系统32位下的教程了) 由于OPC(OLE for Process Control)建立在Microsoft的COM(COmponent Model)基础上,并且OPC的远程通讯依赖Microsoft的DCOM(Distribute COM),安全方面则依赖Microsof的Windows安全设置. 通过网络相互通信,OPC Server(OPC服务端)和OPCClient(OPC客户端)所在的操作

Nginx+php+fastcgi在win7下的配置

首先装载php 1.从www.php.net上下载php对应版本 2.解压之后放到c盘下(其实放哪无所谓,Apache会有配置指向,但是Nginx不用) 3.因为用的5.3.17版本,已经有了php-cgi.exe这个,不用做其他的事情所以开始更改php的配置,先把php.ini-development这个文件更名为php.ini,也有的版本ini后面跟的是别的,都改成.ini 4.打开php.ini文件,修改: 配置: extension_dir = "这里写你的ext文件夹路径"

win7下安装配置nodejs、使用npm安装express

1.下载node http://nodejs.cn/download/ 这里下载自己需要的 我的环境是win764,下载地址是:https://nodejs.org/dist/v6.2.0/win-x64/node.exe 它就一个exe文件,想要使用还要配置下环境变量 win7: “我的电脑”右键点击“我的属性”,点击左边的‘高级系统设置’,在打开的系统属性面板,点击选项卡‘高级’--面板底部的‘环境变量’ 在系统变量找到PATH,在变量值后面,追加上‘D:\node;’ (这是存放node.

cocos2d 2.2.6 win7下的配置

我搭建cocos2.6的开发环境需要安装工具包括: 1.Visual Studio 2012(由于不兼容win7,需要安装Update 4)和虚拟光驱daemon tool,虚拟光驱的下载地址:http://down.52pk.com/xiazai/131.shtml 2.Cocos2d-x 3.6 下载地址为:http://www.cocos2d-x.org/download 3.JAVA JDK 8 下载地址为:http://www.oracle.com/technetwork/java/j