本文介绍了如何在Linux环境下利用Doxygen、Graphviz和Htmlhelp工具来提升代码文档的质量和易读性。Doxygen用于生成代码文档，Graphviz用于展示函数和模块间的调用关系，而Htmlhelp则将生成的html文档转换为CHM文件，便于查看。通过实例——GNOME Power Manager的源码，展示了这些工具的具体应用步骤。
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 |
最低0.47元/天 解锁文章
扫一扫
1001
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
