Doxygen 介绍
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,? 完全 支持 C、C++、Java、Objective-C和IDL语言,部分 支持 PHP 、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源 文件 开始, 生成 html格式的在线类浏览器,或离线的LATEX、RTF参考手册。
Doxygen 是 一个 程序的 文件 产生工具,可将程序中的特定批注转换成为说明 文件 。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为 一个 纯粹的参考手册,对于后面利用您的程序 代码 的人而言将会减少许多的负担。不过,反过来说,整理 文件 的工作对于您来说,就是沉重的负担。
Doxygen 就是在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文档了。
?
因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文档。
Doxygen使用步骤?
1、第一次使用需要安装doxygen的程序?
2、 生成 doxygen 配置文件 ?
3、编码时,按照某种格式编写注释?
4、 生成 对应文档
网站地址 : http://www.doxygen.nl/
GitHub: https://github.com/doxygen/doxygen
网站描述: 一种开源跨平台的文档系统
Doxygen官方网站
官方网站: http://www.doxygen.nl/
如果觉得 网站内容还不错,欢迎将 网站 推荐给程序员好友。