Doxygen是事实上的标准工具,可从带注释的C ++来源生成文档,但它也支持其他流行的编程语言,例如C,Objective-C,C#,PHP,Java,Python,IDL(Corba,Microsoft和UNO / OpenOffice等) ),Fortran,VHDL和某种程度上是D。
Doxygen可通过三种方式为您提供帮助:
它可以$ \ mbox {\ LaTeX} $从一组已记录的源文件中生成一个在线文档浏览器(HTML)和/或一个离线参考手册(in )。还支持在RTF(MS-Word),PostScript,超链接PDF,压缩HTML和Unix手册页中生成输出。该文档是直接从源代码中提取的,这使得使文档与源代码保持一致变得容易得多。
您可以配置 doxygen从未记录的源文件中提取代码结构。这对于在大型源代码发行版中快速找到您的方式非常有用。Doxygen还可以通过包括依赖关系图,继承图和协作图的可视化各种元素之间的关系,这些依赖图,继承图和协作图都是自动生成的。
您也可以使用doxygen来创建常规文档(就像我在doxygen用户手册和网站上所做的那样)。
Doxygen是在Mac OS X和Linux下开发的,但设置为高度可移植的。结果,它也可以在大多数其他Unix版本上运行。此外,还提供Windows可执行文件。
1