- 浏览: 1527393 次
- 性别:
- 来自: 北京
文章分类
- 全部博客 (225)
- JAVA (27)
- Spring (49)
- Linux (51)
- JavaScript (8)
- Scrum (23)
- IDE (2)
- JSON (2)
- Solr (0)
- Webharvest (0)
- Hibernate (8)
- 杂谈 (3)
- Windows 7 (4)
- 持续集成 (23)
- tomcat (3)
- Android (1)
- SpringSecurity (11)
- Maven (9)
- jotm (3)
- C3P0 (1)
- Active Directory (2)
- cas (1)
- JQuery (2)
- ajax (1)
- plsql (2)
- nginx (4)
- apache (1)
- thrift (7)
- python (3)
- oracle (4)
- php (2)
- redis (1)
- fedora (1)
- windows7 (0)
- SVN (1)
- NFS (1)
- SAMBA (1)
- Atomikos (1)
- apache-poi (1)
- mysql (2)
- vncserver (1)
- mac (2)
- firefox (1)
- JIRA (1)
- p6spy (1)
- git (1)
- github (1)
- gitlab (1)
- gogs (1)
- Druid (1)
- MyBatis (1)
- docker (8)
- zabbix (1)
最新评论
-
lialatd:
您好,我用您的方法通过java api往jira系统中添加is ...
JIRA REST API ---- JAVA -
sprcen945:
可以了,是因为没加intercept-url 的拦截, 尼玛, ...
SpringSecurity3.X--Cas client 配置 -
sprcen945:
请问为什么我配了security.xml后切入点不起作用(之前 ...
SpringSecurity3.X--Cas client 配置 -
linxingyul:
根据楼主的代码 继承了WebMvcConfigurationS ...
SpringMVC4零配置--Web上下文配置【MvcConfig】 -
java_老头:
MvcConfig.java的FilterType.ANNOT ...
SpringMVC4零配置--Web上下文配置【MvcConfig】
doxygen是用于从java源代码生成技术文档的工具,有些类似javadoc,但是比javadoc界面要漂亮许多,而且配合graphviz,可以生成带UML图表的文档。
doxygen可以通过ant插件集成到ant构建任务中,这样可以通过ant构建任务自动从最新的源代码中生成最新的文档。
看一下效果图吧:
Doxygen官网地址:http://www.stack.nl/~dimitri/doxygen/index.html
这么漂亮的文档时如何生成的呢?
一。安装
需要安装三个工具
1.graphviz linux安装参考http://hanqunfeng.iteye.com/blog/869293
2.doxygen linux安装参考http://hanqunfeng.iteye.com/blog/874154
3.doxygen的ant插件
前两个工具在windows下都有安装包,一步一步安装就行,linux安装参考所给连接即可。
这里只介绍第三个工具的安装,实际上就是一个ant的插件。
官网地址:http://sourceforge.net/projects/ant-doxygen/
目前最新版本为1.6.1
下载后解压即完成安装:
tar -zxvf ant-doxygen-bin-1.6.1.tgz --directory=ant-doxygen
其实我们要用到的就是ant-doxygen/lib/ant_doxygen.jar
二。编写ant任务
<!-- ant-doxygen lib包路径 --> <property name="ant_doxygen.lib" location="${ant_doxygen.home}/lib" /> <!-- doxygen路径 --> <property name="ant_doxygen.dir" location="${reports.dir}/doxygen" /> <taskdef name="doxygen" classname="org.doxygen.tools.DoxygenTask" classpath="${ant_doxygen.lib}/ant_doxygen.jar"/> <target name="doxygen"> <delete dir="${ant_doxygen.dir}" /> <mkdir dir="${ant_doxygen.dir}" /> <doxygen> <property name="PROJECT_NAME" value="${ant.project.name}" /> <property name="PROJECT_NUMBER" value="0.1" /> <property name="OUTPUT_DIRECTORY" value="${ant_doxygen.dir}" /> <property name="JAVADOC_AUTOBRIEF" value="YES" /> <property name="TAB_SIZE" value="4" /> <property name="OPTIMIZE_OUTPUT_JAVA" value="YES" /> <property name="INPUT" value="${src.dir}" /> <property name="RECURSIVE" value="YES" /> <property name="HAVE_DOT" value="YES" /> <property name="UML_LOOK" value="YES" /> <property name="CLASS_GRAPH" value="YES" /> <property name="COLLABORATION_GRAPH" value="YES" /> <property name="GROUP_GRAPHS" value="YES" /> <property name="DIRECTORY_GRAPH" value="YES" /> <property name="SHOW_DIRECTORIES" value="YES" /> <property name="SOURCE_BROWSER" value="YES" /> <property name="STRIP_CODE_COMMENTS" value="NO" /> <property name="GENERATE_LATEX" value="NO" /> <property name="GENERATE_TREEVIEW" value="YES" /> </doxygen> </target>
以上配置基本上可以保证生成一个比较完整的文档,关于各个属性的介绍,可以参考如下地址:
http://hi.baidu.com/zkheartboy/blog/item/8ed283cae6a06c80c8176858.html
执行这个ant任务即可自动生成文档。
三。后记
doxygen生成的文档确实比javadoc生成的文档要漂亮许多,而且可以生成uml图表,不过javadoc配合UmlGraph,也可以生成uml图表,而且通过UmlGraph还支持外部api的导航。不过doxygen比较强的的地方是其对注释格式的简单要求,以及可以在文档中显示源代码,使文档更加完成。
关于UmlGraph的介绍可以参考http://hanqunfeng.iteye.com/blog/869576
两个工具各有优势,可依据具体情况进行选择。
发表评论
-
Oracle数据库文档构造器--Oraschemadoc
2011-06-30 18:23 1428Oraschemadoc---Oracle Schema Do ... -
用SchemaSpy制作数据库结构文档
2011-02-14 16:12 2338在包含数据库的项目管理中,数据库文档是一个不可缺少的资源,一般 ... -
用UmlGraph在Javadoc中嵌入UML图表
2011-01-12 17:35 3815最近在看《Java Power Tools》,对UmlGrap ... -
hudson--构建存档
2011-01-11 11:25 1877每一次构建,hudson都会在HUDSON_HOME/jobs ... -
hudson--javadoc报告
2011-01-11 10:30 2197使用hudson可以很方便的将javadoc报告集成进来,当然 ... -
hudson--findbugs报告
2011-01-06 11:13 6959如果我们的ant构建文 ... -
hudson--构建依赖
2011-01-04 14:39 2027hudson一个比较好的功能是提供了构建依赖,就是说,一个jo ... -
hudson--环境变量
2011-01-04 14:17 4379在执行构建时,我们可以为每个JOB指定一些环境变量,方法如下: ... -
hudson--build配置
2011-01-04 11:55 3066在每个job中,我们可以指定其构建方式,比如是通过ant或ma ... -
hudson--安全设置
2011-01-01 17:44 4650hudson默认是不需要登录 ... -
hudson--junit测试报告
2010-12-31 18:46 6346如果你的项目在构建时进行了单元测试,可以在hudson中直接查 ... -
hudson--部署设置
2010-12-31 18:23 3699需要为hudson安装Deploy to container ... -
hudson--JOB_WORKSPACE
2010-12-31 18:04 2288JOB_WORKSPACE:就是构建时使用的目录,也就是从代码 ... -
hudson--构建执行顺序
2010-12-31 17:30 2268hudson的构建顺序与普通的持续集成一样,遵循着先更新代码- ... -
hudson--scp设置
2010-12-31 17:18 4141如果是远程部署,你就会需要一个scp插件,可以在hudson的 ... -
hudson--配置邮件
2010-12-31 15:52 3296如果希望在构建完成后将构建结果以邮件的形式发送给相关的用户,推 ... -
hudson--系统管理
2010-12-31 15:08 2046hudson的总体配置,都是在“系统管理”中进行配置的,hud ... -
hudson--URL选项
2010-12-31 14:11 1374hudson为我们提供了一些通过url快速执行的功能 htt ... -
hudson--HUDSON_HOME
2010-12-31 13:54 4466Hudson需要一些磁盘空间来执行构建 ... -
hudson--插件管理
2010-12-30 18:25 7466hudson的好用基本体现在其众多而强大的插件上,在“系统管理 ...
相关推荐
google 上搜了很久的关于 Doxygen 使用方法的咚咚,只不过都是英文,而且都很多的规则。实际上大家只需要告诉基本的规则就可以。下面是我对 Doxygen 的摸索 首先熟知 Doxygen 产生的文件的基本结构
Doxygen最新版,给源代码生成文档的利器,支持多种编程语言!
在VS代码中生成Doxygen注释 通过启动Doxygen注释块并按Enter,此VS Code扩展可以即时生成Doxygen文档。 目录 产品特点 对准 有关其工作原理,请参见 属性 析构函数 广泛的定制 档案说明 功能指针 经营者 参量 退货...
windows下使用doxygen为C C++程序生成中文文档 1.html文件讲解怎么使用 2.需要的一些工具 3.所需要的批处理文件 步骤: 1.阅读 使用doxygen为C/C++程序生成中文文档html文件 2.安装doxygen.rar,graphviz.rar ...
该文档是直接从源代码中提取的,这使得使文档与源代码保持一致变得容易得多。 您可以配置 doxygen从未记录的源文件中提取代码结构。这对于在大型源代码发行版中快速找到您的方式非常有用。Doxygen还可以通过包括依赖...
使用Doxygen生成全中文的chm文档 生成类图 项目一般设置 首先在“Wizard”标签的Project项进行如下设置: 项目名称:将在最新的文档首页中显示 源码列表:选择要生成文档的源代码或目录 可以有多个文件或目录...
您可以在DoxygWizard里对需要生成的文档进行设置,可保存为"Doxyfile",然后调用Doxygen生成文档。需要注意的是,文件路径不支持中文,所以尽可能使您的源代码和文档目录均为英文名。在"Doxyfile"文件同一目录请放置...
doxygen 可以为 c,c++,java 等语言写的程序生成文档(从程序的源代码中提取其中按照约定格式写的 注释中提取信息)。查看 doxygen 的 man 手册,翻译如下: 许多使用 doxygen 的方法: 1)使用 doxygen 生成一个配置...
首先向大家介绍一下如何利用Irrlicht的源代码和doxygen生成帮助文档。进入irrlicht目录,在irrlicht-1.7.3/scripts/doc/irrlicht中,Windows下点击makedocumentation.bat,Linux下点击makedocumentation.sh,就可以...
容器运行后,转到YOUR_PROJECT_NAME目录,并通过以下命令为您的源代码生成文档: $ cd [YOUR_PROJECT_NAME] $ doxygen ../c-doxygen.conf 打开浏览器并导航到[YOUR_SOURCE_CODE_DIR_ABSOLUTED_PATH]/...
matlab生成得exe源代码强力药 该软件包允许您使用Doxygen从Matlab .m文件中自动提取注释,以生成文档。 该软件包提供: 一个用于过滤.m文件的perl脚本(m2cpp.pl),以便Doxygen可以理解它们 Doxyfile文件(Doxygen...
Doxygen可以从C,C++, java等源代码中提取消息来生成帮助文档, API资料等
Doxygen 是一个类似 JavaDoc 的文档生成工具。有了它,C++爱好者就可以为自己的源代码很方便地生成美观实用的文档了。 为代码生成文档标注基础
安装该插件后,可以在VS的菜单中显示“注释”主菜单,可以给类、函数、成员添加标准的注释,与Doxygen配合使用,可以直接生成项目的注释文档。 源代码: https://github.com/langyastudio/vs-autocomment 说明文档...
文档是直接从源文件中提取出来的,这使得文档与源代码很容易保持同步。 2,通过配置doxygen,你可以从未文档化的源文件中提取出代码结构。这对于从大的源码包中快速理清头绪是非常有用的。它还能自动产生出包含...
根据OSG3.01源代码,采用Doxygen工具生成的帮助文档,只可惜源代码注释太少,有的函数压根没注释,几乎所有的函数都没有参数以及返回值的注释(更让人汗颜的是,包含文件木有.h后缀,需要修改后缀名,doxygen才能...
doxygen 是一种用于 C/C++、Java™、Python 和其他编程语言的文档系统,生成HTML格式的在线类浏览器 doxygen可以提取在源代码中的注释,并分析将此转换成HTML文档,也可以当做手册使用,功能很强大
通过DoxyGen基于源代码生成的 Openbiz API 3.0 文档 HTML 版本。本文档主要展示类各个模块之间的相互调用和继承关系。公开的API函数接口 和 返回值类型等信息。 对于初学Openbiz框架具有很高的参考价值。可以让...
适合根据源代码生成相关文档,减轻了说明文档撰写的工作。
OpenSCAD文档生成器这个包从在线源代码注释中生成可用于Wiki的GitHub风格的Markdown文档页面。 这类似于Doxygen或JavaDoc,但设计用于OpenSCAD代码。 可以从简短的示例脚本自动生成示例图像。 可以在找到有关如何向...