Doxygen

编程之家收集整理的这个编程导航主要介绍了Doxygen编程之家,现在分享给大家,也给大家做个参考。

Doxygen

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/

如果觉得编程之家网站内容还不错,欢迎将编程之家网站推荐给程序员好友。

相关文章

Wiki.js,一款基于NodeJS的轻量级wiki
phpcms,领先的网站内容管理系统|网站管理系统
BeautifulOpen,由GroupOn开发团队开放的免费开源JS库集合
vue-storefront,为电子商务打造的 PWA
CMSmap,一个Python编写的针对开源CMS的安全扫描器
MetInfo,专业的企业级CMS建站系统