打印

doxygen in linux

[复制链接]
153|0
手机看帖
扫描二维码
随时随地手机跟帖
跳转到指定楼层
楼主
喷水壶|  楼主 | 2018-10-6 11:40 | 只看该作者 回帖奖励 |倒序浏览 |阅读模式
doxygen in ubuntu linux 9.10



1, apt-get install doxygen

2, apt-get install graphviz

3, apt-get install htmlhelp



1,doxygen -g doxygen.conf 生成doxygen的配置文件

2,修改doxygen.conf

3,doxygen doxygen.conf 生成文档

4, 最后默认在目录docs下生成对应格式的文档



以下是我默认的一些选项,最好还是自己有一个模板,视情况简单改几项就OK

## Doxygen 1.6.1

## Doxyfile 1.3.8

# 以下为一些比较重要的项目

PROJECT_NAME = MY_TEST_PROJECT # 项目名

PROJECT_NUMBER = v1.0 # 版本号

OUTPUT_LANGUAGE = Chinese # 输出语言设置

EXTRACT_ALL = YES # 输出所有的函数,除去private,static

EXTRACT_PRIVATE = YES # 输出private函数

EXTRACT_STATIC = YES # 输出static函数

EXTRACT_LOCAL_METHODS = YES # 输出本地函数

HAVE_DOT = YES # 使用graphviz

CALL_GRAPH = YES # 输出调用关系

OUTPUT_DIRECTORY = ./docs/ # 输出目录

RECURSIVE = YES # 包括子目录

SOURCE_BROWSER = YES # 源代码浏览

TAB_SIZE = 4 # TAB的大小

GENERATE_LATEX = NO # 不生成LATEX格式



doxygen是个由源代码生成文档的工具,再具体的就不多说,百度或google吧

如果注释写得好的话,通过doxygen生成的文档是相当好的

现在很多开源的或非开源都通过它生成SDK的文档,真是省时省力

生成的文档可以是html的,也可以是chm、latex、pdf、xml等



文档本来就是开发与维护之间很大的一个问题,通过doxygen可以大大节省劳动力

当然,前提是要养成写好注释的好习惯



这两天,发现doxygen除了可以生成注释的文档后,还有一个相当棒的功能

感叹hacker们真是把其发挥极致

其功能就是生成函数调用图,类继承图等

这些用来分析程序结构是相当好

平时我分析程序也是一边看一边画这些类,现在终于是不用画了,跑一个命令全搞定!



现在的懒人也可以懒到极致!



另外,习惯了用linux或者windows下的cygwin,也就是习惯了unix hacker那套

windows界面那套就不多弄了,原理一样,可能只是doxygen的版本更高,配置文件

内容不同



更多参考:

http://www.fmddlmyy.cn/text21.html

http://www.codeproject.com/KB/tips/doxysetup.aspx

http://www.cnblogs.com/wangkangluo1/archive/2011/07/29/2121372.html

http://hi.baidu.com/vcba/blog/item/9dcea11ce5d3328087d6b69c.html





最后,其实大家可能都好奇,doxygen是如何得到变量名,函数名,类名,函数调

用关系,类关系等等

当然,变量名、函数名与类都是编译器的范畴,都是静态的

可是函数调用我理解为应该链接或运行时的范畴了,这还是可以值得研究一下

然后就发现了天后的天



1,分析函数调用关系图(call graph)的几种方法

http://www.cppblog.com/hacrwang/archive/2007/06/30/27295.html



2, 用Graphviz 可视化函数调用

http://www.ibm.com/developerworks/cn/linux/l-graphvis/



看完这些,发现自己的hacker精神正在慢慢被磨灭,why??????????

使用特权

评论回复

相关帖子

发新帖 我要提问
您需要登录后才可以回帖 登录 | 注册

本版积分规则

433

主题

437

帖子

0

粉丝