首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 软件管理 > 软件开发 >

用Doxygen生成源代码文档-摘引

2012-08-10 
用Doxygen生成源代码文档-引用引用说明:原文来自于?http://www.iteye.com/topic/874927,为了方便本人阅读,

用Doxygen生成源代码文档-引用

引用说明:原文来自于?http://www.iteye.com/topic/874927,为了方便本人阅读,文本格式略有调整。

?

doxygen是用于从java源代码生成技术文档的工具,有些类似javadoc,但是比javadoc界面要漂亮许多,而且配合graphviz,可以生成带UML图表的文档。

?

doxygen可以通过ant插件集成到ant构建任务中,这样可以通过ant构建任务自动从最新的源代码中生成最新的文档。

看一下效果图吧:

用Doxygen生成源代码文档-摘引

?

以上配置基本上可以保证生成一个比较完整的文档,关于各个属性的介绍,可以参考如下地址:

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

?

两个工具各有优势,可依据具体情况进行选择。

?

热点排行