Doxygen 一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件
来源:互联网 发布:python 连接sqlserver 编辑:程序博客网 时间:2024/06/06 17:02
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
简介:
Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。
对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。
一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。
Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。
0 0
- Doxygen 一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件
- java程序打包成为可运行的exe文件
- 文件特定内容替换的小程序
- 将一个程序中的cout获取出来生成日志文件
- 一个将html文件批量转换成jsp文件的程序(主要处理中文乱码问题)
- Doxygen-程序文档工具
- 用java语言将数据库中的数据表转换为xml文件的通用程序
- 用myeclipse如何将java程序生成一个.exe可运行文件?
- 用myeclipse如何将java程序生成一个.exe可运行文件?
- 用eclipse如何将java程序生成一个.exe可运行文件?
- 用eclipse如何将java程序生成一个.exe可运行文件
- 编写一个程序,将文件打包,在需要解包。可以得到你想要的打包中的文件。
- Linux 将查找的文件合并成为一个文件
- 使程序产生core文件
- 如何将unity的project中的特定文件打包
- GDB调试Core文件(程序异常产生的文件)
- 一个Echo文件的程序
- 一个文件分割的程序
- hdu 1163
- Qt应用程序向ARM开发板移植过程中汉字无法正常显示的解决办法
- CentOS 修改系统字符集编码
- JavaScript Date(日期)对象
- Linux---TCP连接数
- Doxygen 一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件
- Axis WSDD文件参考文档
- phonegap下载文件并打开
- Vim命令合集
- setter方法的内部实现【不要在init和dealloc函数中使用accessor】
- PCB布高速线时需要考虑得信号传输延时
- 查找指定目录下的文件夹或文件
- Mina源码分析——IoService
- day64(5.15)MyEclipse 10.0及更高版本激活