Chinaunix首页 | 论坛 | 博客
  • 博客访问: 1520669
  • 博文数量: 1481
  • 博客积分: 26784
  • 博客等级: 上将
  • 技术积分: 17045
  • 用 户 组: 普通用户
  • 注册时间: 2011-07-12 09:22
文章分类

全部博文(1481)

文章存档

2014年(10)

2013年(353)

2012年(700)

2011年(418)

分类: 系统运维

2012-12-25 10:23:42

上个星期闫海静老师给我们讲如何使用PEAR把特定的批注转换成为说明文件,在闫海静老师给我们演示完安装和使用以后,我亲自操作了一下,感觉这东西对于我来说有点不适应,在安装过程中还需重启这让人有点无法接受……还有就是我们现在绝大多数的时间都是在使用windows可视化的操作,然而这个东西需要在DOS来操作完成,总之安装的繁琐与使用时的不适应让我不得不去寻找另一个同样的工具,然后就找到了我发的这个东西,Doxygen但是由于上传限制,没法上传软件,只能写上地址自行下载和安装(15.3M),使用说明下载附件即,喜欢的可以下载来试试。

下面是软件的简介(来自百度):
Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。
  对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、 RTF、PostScript、PDF、HTML和Unixman page等。
  一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。
  Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。
可处理的程序语言

  * C/C++
  * Java
  * Objective-C
  * Python
  * IDL (Corba, Microsoft及KDE-DCOP类型)
  * Fortran
  * VHDL
  * PHP
  * C#
可产生的文件格式

  * HTML
  * XML
  * LaTeX
  * RTF (MS-Word)
  * PostScript
  * Unix Man Page
  而其中还可衍生出不少其它格式。如有了LaTeX 文件后,就可以透过一些工具产生出PS或是PDF档案。
  在多国语言的支持方面,Doxygen 目前可支持的约有2,30种。自Doxygen 1.2.16开始支持繁体中文(这正是小弟做的好事)。所以在目前一些Open Source 的程序文档管理器中,Doxygen 算是相当完整的一套。在程序语言处理上面,Doxygen也算是少数在Borland C++Builder 的语法下还能够正常运作的工具之一(若非如此,小弟也不会推荐它)。
  本文的目的是希望在经过仔细阅读本文之后能够给大家一个概略性的了解。以便可以很容易的上手使用Doxygen。至于Doxygen本身的详细使用,各位可以参考随着Doxygen 所附的文件。实际上,Doxygen 自己的使用手册就是使用Doxygen 产生的。您可以看到他实际上能够产生远比Reference Book更复杂的文件。
--------------------------------------
Doxygen官网:
Doxygen官网下载地址:
原文地址:
阅读(1031) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~