Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码 然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的办法呢?比如根据代码注释自动生成详尽的说明文档……可能有人会说用Javadoc就是 了,要是C/C++、Python、C#等语言写的软件呢?有没有类似Javadoc的东西?
Yes,当然有,Doxygen就是这样一个能满足你需求的工具。Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,可将程序中的特定批注转换成为说明文件,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。被Boost、OpenCasCade等诸多项目作为文档生成工具的不二选择。
由于我主要的开发语言是Java,所以在这里主要说明Doxygen在Eclipse里的集成及使用步骤。
1. 安装doxygen工具
在集成之前需要安装doxygen工具,下载方法有两种:目前最新版是1.8.6
(1)官方网站下载(建议):Doxygen:Downloads
(2)在sourceforge下载:Doxygen
2.安装doxygen在Eclipse中的插件:Eclox
建议在其官方网站下载:Eclox
下载eclox_0.8.0.zip后解压,安装插件的方法也有几种:
1. 将eclox_0.8.0中的plugins和features目录里的内容,移动到eclipse中的plugins和features目录里重启即可,最简单。
2. 通过links方法安装插件(建议该方法,具体可Google)。
2. 采用Eclipse里的update manager安装插件,具体方法请看这里。
注意:网上都说同时要下载eclox.update_0.8.0.zip并解压安装,其实完全没必要,eclox.update_0.8.0只是版本的更新过程,里面包含的都是最新版本和历史版本插件,而我们需要的只是最新版本的,故不需要下载此压缩文件。
如果这两个步骤都完成后,重启eclipse之后,就可以发现在工具栏上多了一个@的图标,如下图所示,表示安装成功。
3. 在Eclipse中配置doxygen运行环境
工具栏上 windows->preferences->Doxygen, 点击Add,添加doxygen安装目录中的bin目录,如下图所示:
到此doxygen在Eclipse中的集成工作就完成了。
4. 使用Doxygen生成文档过程举例
4.1 自动生成工程的doxygen文件
首先选择你要生成文档的工程,
然后File->New->others....,出现下面的选择框,选择Other中的Doxyfile。
点击next,配置Doxygen,定好文件的名字,点击Finish就OK了。
当然到此还没结束,最重要的一步还没完成,就是自动生成doxygen文件后需要我们自己配置各个参数和选项。
4.2 配置doxygen文件参数和选项
配置Doxygen文件参数也有三种方式:
4.2.1 使用Eclipse中集成的doxygen editor进行修改
在Eclipse中打开刚刚自动生成的doxygen文件,默认的配置如下:
比如在Eclipse中我用的配置选项如下:
建议大家如果不理解各个选项,可以尝试每个选项的生成效果,以找出自己最想要的文档格式。
4.2.2 使用Doxygen安装程序自带的GUI工具
找到Doxygen的安装目录下的bin目录里,如下图所示可以看到有个GUI工具:
打开后如下图所示:
与Eclipse中大同小异,各个参数选项慢慢琢磨吧,很简单。
4.2.3 直接用文本编辑器进行修改
针对doxyfile可直接用文本编辑器进行编辑,建议用Notepad++或写字板等打开,不要用无排版的记事本。
主要有以下内容需关注:
<OUTPUT_DIRECTORY>
:必须在这里提供一个目录名,例如 /home/user1/documentation,这个目录是放置生成的文档文件的位置。如果提供一个不存在的目录名,doxygen 会以这个名称创建具有适当用户权限的目录。<INPUT>
:这个标记创建一个以空格分隔的所有目录的列表,这个列表包含需要生成文档的
源代码文件和头文件。如果项目只有一个源代码根目录,其中有多个子目录,那么只需指定根目录并把
C/C++<RECURSIVE>
标记设置为Yes。<FILE_PATTERNS>
:在默认情况下,doxygen 会搜索具有典型C/C++
扩展名的文件,比如.c、.cc、.cpp、.h 和.hpp。如果<FILE_PATTERNS>
标记没有相关联的值,doxygen 就会这样做。如果源代码文件采用不同的命名约定,就应该相应地更新这个标记。例如,如果项目使用.c86 作为C
文件扩展名,就应该在<FILE_PATTERNS>
标记中添加这个扩展名。<RECURSIVE>
:如果源代码层次结构是嵌套的,而且需要为所有层次上的C/C++
文件生成文档,就把这个标记设置为Yes。例如,请考虑源代码根目录层次结构 /home/user1/project/kernel,其中有 /home/user1/project/kernel/vmm 和 /home/user1/project/kernel/asm 等子目录。如果这个标记设置为Yes,doxygen
就会递归地搜索整个层次结构并提取信息。<EXTRACT_ALL>
:这个标记告诉 doxygen,即使各个类或函数没有文档,也要提取信息。必须把这个标记设置为Yes。<EXTRACT_PRIVATE>
:把这个标记设置为 Yes。否则,文档不包含类的私有数据成员。<EXTRACT_STATIC>
:把这个标记设置为 Yes。否则,文档不包含文件的静态成员(函数和变量)。<OUTPUT_LANGUAGE>
:默认 = English,文档语言(自动生成的文字部分),可以指定为Chinese。<DOXYFILE_ENCODING>
:默认 = UTF-8,默认编码为UTF-8,这样可以支持中文。<PROJECT_NAME>
:项目名称,多个单词需要使用引号(“”)。<PROJECT_NUMBER>
:项目版本号。
4.3 运行doxygen文件生成最后的文档
配置完成后在Eclipse中点击@插件按钮选择doxygen配置文件即可生成文档了。
可以在控制台看到生成详细过程,如果有如何配置错误如指定的路径或文件不存在等,都会给出提示,按要求重新配置即可。
打开生成文档里的index.html(如果是html格式),在浏览器查看,点击各个选项查看效果如下:
主界面:
查看某个函数的界面:
更多
0
Doxygen自动文档生成工具在Eclipse中的集成及使用举例的更多相关文章
- 安装doxygen(一个自动文档生成工具)+Graphviz图形可视化软件
参考文章: http://www.fmddlmyy.cn/text21.html http://www.cnblogs.com/duguguiyu/archive/2008/06/29/1231852 ...
- (转)Doxygen文档生成工具
http://blog.csdn.net/lostaway/article/details/6446786 Doxygen 是一个支持 C/C++,以及其它多种语言的跨平台文档生成工具.如同 Java ...
- 文档生成工具doxygen+图像生成工具GraphViz
文档生成工具doxygen+图像生成工具GraphViz 虽然jdk自带的javadoc也很好用,不过使用doxygen+GraphViz 的组合可以生成许多强大的图(类图.协作图.文件包含/被包含图 ...
- 【C#附源码】数据库文档生成工具支持(Excel+Html)
[2015] 很多时候,我们在生成数据库文档时,使用某些工具,可效果总不理想,不是内容不详细,就是表现效果一般般.很多还是word.html的.看着真是别扭.本人习惯用Excel,所以闲暇时,就简单的 ...
- .NET平台开源项目速览(4).NET文档生成工具ADB及使用
很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习一些开源项目的过程中,官方没有提供CHM帮助文档,所以为了快速的了解项目结构和注释.就生成文档来自己看,非常好用.这也是一个学习方法吧 ...
- Sandcastle----强大的C#文档生成工具
最近客户索要产品的二次开发类库文档,由于开发过程中并没有考虑过此类文档,而且项目规范比较,持续时间比较长,经手人比较多,还真是麻烦,如果人工制作文档需要是一个比较大的工程.还好有这个文档生成工具,能够 ...
- 使用Objective-C的文档生成工具:appledoc
使用Objective-C的文档生成工具:appledoc 前言 做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象 Ja ...
- 使用Objective-C的文档生成工具
前言 做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象Java语言本身就自带javadoc命令,可以从源码中抽取文档.今 ...
- Markdown 文档生成工具
之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协 ...
随机推荐
- Java应用分类
Java应用分类 一.应用程序.指在操作系统上直接运行的,不是浏览器,Java环境用本机的,需要在客户端安装,Java环境可以一起安装. 1.GUI图形界面应用程序 ...
- wordpress和数据库的连接
1.首先在数据库里创建wordpress数据库 2.在网页上配置WordPress,安装WordPress 如上配置不对,提交时提示了错误,于是我选择了root用户 123456, 3.提交后,连上了 ...
- cxgrid动态创建列
cxgrid动态创建列 procedure TFrmRuleEdit.CreateCols;varColumn: TcxGridDBColumn;begincdsPowerPrj.First;whil ...
- ThreadLocal实现线程级上下文
一.ThreadLocal测试 package com.junge.threadlocal.context; /** * @author Administrator * */ public class ...
- linux常用命令(二)文件上传下载及软件安装
1.上传下载工具安装 (1)WINDOWS 到linux的文件上传及下载: windows下打开secureCRT,通过SSH连到⾄至远程linux主机:上传下载工具安装命令:yum -y insta ...
- ASP .Net C# ---CSV导入导出
CSV和Excel大致相同 复制下来 数据传到方法里面就可以了 /// <summary> /// DataTable数据写入CSV文件 /// </summary> /// ...
- WPF ListBox的进阶使用(二)
项目中经常使用需要根据搜索条件查询数据,然后用卡片来展示数据.用卡片展示数据时,界面的宽度发生变化,希望显示的卡片数量也跟随变化.WrapPanel虽然也可以实现这个功能,但是将多余的部分都留在行尾, ...
- ASP.Net MVC OA项目笔记<二>
1.1.0 创建数据层 1.1.1 CZBK.ItcastOA.IDAL 引用 CZBK.ItcastOA.Model 1.2.1 给IDAL添加一个接口IUserInfoDal 里面写增删改查分页的 ...
- cpu 亲和性 affinity
http://www.ibm.com/developerworks/cn/linux/l-affinity.html
- .NET Core 从1.1升级到2.0记录(Cookie中间件踩坑)
.NET Core 2.0 新时代 万众瞩目的.NET Core 2.0终于发布了,原定于9.19的dotnetconf大会的发布时间大大提前了1个月,.NET Core 2.0/.NET Stand ...