统计

  • 随笔 - 50
  • 文章 - 42
  • 评论 - 147
  • 引用 - 0

留言簿(6)

随笔分类

文章分类

Link

搜索

  •  

积分与排名

  • 积分 - 160257
  • 排名 - 161

最新评论

阅读排行榜

评论排行榜

Doxygen + Graphviz + Htmlhelp, 成为文档好手

doxygen

 

在Linux下面开发,在代码中一般注释doxygen格式的注释,这是帮助我们生成文档的一个好方法。

对于doxygen的主要是语法,网上有很多的说明,有个工程:GNOME Power Manager里面的doxygen

注释写的非常好,你们可以下载下来看看,并且可以借鉴到自己的实际开发中。

 

这里我想说的是:如何从source code 总提取开源软件的文档。

 

有3个工具可以先安装一下:

1 doxygen

2 Graphviz

3 htmlhelp

 

 

1 doxygen是大名鼎鼎代码文档工具。

下载地址:www.doxygen.org

安装它。

 

 

2 Graphviz

这个工具配合doxygen使用,可以提取函数,模块之间的调用关系,非常清晰。

下载地址:http://www.graphviz.org/Download..php

 

下面是Graphviz提取出来的一些关系图:

cluster crazy datastruct fsm
hello profile sdh switch
unix world twopi2 ER
fdpclust process softmaint transparency

 

 

 3 htmlhelp

这个工具把doxygen生成的html文件,转化为一个CHM文件,看起来方便些。

 下载地址:http://www.softpedia.com/get/Authoring-tools/Help-e-book-creators/HTML-Help-Workshop.shtml

安装它。

 

4 我们以GNOME POWER Manager为例,看看如何使用这些工具,提供我们的文档能力。

 源码下载地址:

http://www.gnome.org/projects/gnome-power-manager/

 

 

 下载源码,解压后,我们来看看如果使用上面的3个工具:

首先用doxygen:

  
 
生成的帮助文档里面带有,call graph.
接着用htmlhelp workshop:
 
生成的CHM文件:
以及各个调用关系,一目了然:
从生成的代码注释上看,GNOME Power Manager对于注释用的是非常好的,这可以用到我们的实际开发中。
另外GNOME Power Manager是对GObject用的最好的,大家也可以借鉴其用法。

posted on 2009-05-06 14:49 pear_li 阅读(1174) 评论(0)  编辑 收藏 引用 所属分类: Version control


只有注册用户登录后才能发表评论。
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理