Chinaunix首页 | 论坛 | 博客
  • 博客访问: 4157511
  • 博文数量: 553
  • 博客积分: 13864
  • 博客等级: 上将
  • 技术积分: 11042
  • 用 户 组: 普通用户
  • 注册时间: 2011-11-28 21:25
个人简介

个人Blog: hhktony.com

文章分类

全部博文(553)

文章存档

2015年(1)

2014年(2)

2013年(12)

2012年(384)

2011年(154)

分类: LINUX

2012-09-20 07:45:58

doxygen 能够自动分析源代码并从源代码中抽取相应的注释,整理成文档。

它的好处是源代码与文档同步,易于维护

安装

# yum install doxygen

使用

doxygen 生成文档的基本方式是先生成一个配置文件,告诉doxygen如何去生成文档,然后让doxygen生成文档。由于doxygen的配置文件选项有很多,因此我们通常是让doxygen先生成一个默认的配置文件,再修改其中的一些选项,生成自己的配置文件。

1)生成默认配置文件

首先用 cd 命令,进入 源代码所在的文件夹然后运行 doxygen -g 命令,生成 默认的配置文件
因为没有指定配置文件的文件名,因此生成的默认配置文件 自动命名为 Doxyfile

2)修改配置选项

用任何一种文本编辑器,打开 Doxyfile 文件

下面是一些配置选项及说明

RECURSIVE = YES   这可以让doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件
SOURCE BROWSER = YES 这会在最后生成的文档中,把所有的源代码包含在其中
INLINE SOURCES = YES 这会把函数的实现部分的代码包含在每个函数的说明部分,可以方便地查看函数的实现方式,但会让整个文档显得有些凌乱,故不推荐使用
GENERATE TREEVIEW = ALL 这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE_LATEX = NO 这个设置将导致doxygen不生成pdf文档,不太喜欢pdf文档,把它关了吧

3)生成文档

运行 doxygen Doxyfile 命令,生成文档

4)查看文档

在 html 文件夹下,找到 index.html 文件,用浏览器,打开它,就可以查看生成的文档了
阅读(1223) | 评论(0) | 转发(2) |
0

上一篇:locate---安装使用

下一篇:c语言函数高亮

给主人留下些什么吧!~~
评论热议
请登录后评论。

登录 注册