- 软件介绍
Doxygen 程序注释文档生成工具,可将程序中的特定批注转换成为说明文件,非常不错的编程工具。依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。Doxygen 就是在您写批注时,稍微按照一些它所制订的规则,接着就可以帮您产生出漂亮的文档了。
按照约定的格式注释源代码,需要在所有的类、函数、成员函数、公共变量、名字空间等代码已有表示的结构上方添加上指定格式的注释,用工具处理注释过的源代码产生文档。通过这种方式产生文档至少有以下好处:
便于代码和文档保持同步。可以对文档做版本管理。
很多编程语言都有类似的文档工具,例如:Java有javadoc,Ruby有rdoc。对于C/C++程序,我们可以用Doxygen生成文档。
目前Doxygen可处理的程序语言包含:C/C++;Java;IDL (Corba, Microsoft及KDE-DCOP类型)。而可产生出来的文档格式有:HTML、XML、LaTeX、RTF、Unix Man Page。
而其中还可衍生出不少其它格式。HTML可以打包成CHM格式,而LaTeX可以通过一些工具产生出PS或是PDF文档。Doxygen比较适合制作API的接口文档,CHM是这类文档的常见格式。