CSDN博客

img SigmaSys

Doxygen文档

发表于2003/12/25 10:28:00  4520人阅读

 

Doxygen文档

ZhangRui@landwind.com.cn

Doxygen可以为C++, C, Java, IDL (Corba and Microsoft flavors) PHPC#生成文档

大致用途有三:

  1. 可以生成一个在线html文档或者一个离线的LATEX格式文档也支持RTF(MS-Word) PostScript, hyperlinked PDF, compressed HTML, Unix man pages多种格式生成。文档直接由源码生成,这使得保持文档和代码一致性更加轻松。
  2. 可以配置doxygen从无文档的源码中提取代码结构。这就便于在大型源码中迅速上路。也可以将这些不同元素间的关系使用图形表达出来,包括依赖图,继承图和collaboration图,这些都是自动生成的。
  3. 甚至可以使用它来生成平常的文档,例如手册

DoxygenLinux下开发,但高度可移植,可运行在各种平台之下。

这个手册包括下面三个部分,每个部分分为以下几个章节

第一部分是用户手册

第二部分是参考手册

第三部分文档是为开发者准备的:

第一章:出发吧

程序doxygen是分析源码和生成文档的。可以参考Doxytag usage了解详细的使用方法。只是在没有源码时,所以需要生成对外部文档的引用时(例如doxygen所生成的文档),使用Doxytag

下图展示如何工具间的关系和工具间信息的流程
0 0

相关博文

我的热门文章

img
取 消
img