Doxygen最新版是一款开源跨平台的。Doxygen官方版类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。Doxygen以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
Doxygen工具介绍
Doxygen
是一个程序的文件产生工具,可将程序中的特定注释转换成为说明文件。通常我们在写程序时,或多或少都会写上注释,但是对于其它人而言,要直接探索程序里的注释,与打捞泰坦尼克号同样的辛苦。大部分有用的注释都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将注释经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。
Doxygen文件格式
* 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程序语言
* C/C++
* Java
* Objective-C
* Python
* IDL (Corba, Microsoft及KDE-DCOP类型)
* Fortran
* VHDL
* PHP
* C#
Doxygen常见问题
配置文件(Doxyfile)错误
问题描述:
新手在使用Doxygen时,可能会遇到配置文件错误,导致文档生成失败。
解决方案:
检查配置文件:确保Doxyfile文件中的每一项配置都正确无误,特别是INPUT和OUTPUT_DIRECTORY等关键配置项。
使用默认配置:如果配置文件出现问题,可以尝试使用Doxygen提供的默认配置文件。可以通过命令doxygen -g生成一个新的Doxyfile。
逐步调整:在新配置文件的基础上,逐步调整配置项,直到满足需求。
Doxygen更新日志
将bug扫地出门进行到底
优化用户反馈的问题,提升细节体验
华军小编推荐:
Doxygen使用起来十分简单,操作界面优化让您能够轻松找到想要的功能,快来下载吧。小编还为您精心准备了Data Loader、.NET、批量小管家